tomh/ns-3-dev-spectrum-wifi: src/simulator/scheduler.h@48cb60c9eeba (annotated)

9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	1	/* -- Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -- */
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	2	/*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	3	* Copyright (c) 2005 INRIA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	4	* All rights reserved.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	5	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	6	* This program is free software; you can redistribute it and/or modify
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	7	* it under the terms of the GNU General Public License version 2 as
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	8	* published by the Free Software Foundation;
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	9	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	10	* This program is distributed in the hope that it will be useful,
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	13	* GNU General Public License for more details.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	14	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	15	* You should have received a copy of the GNU General Public License
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	16	* along with this program; if not, write to the Free Software
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	18	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	19	* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	20	*/
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	21
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	22	#ifndef SCHEDULER_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	23	#define SCHEDULER_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	24
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	25	#include <stdint.h>
25 9b3bb088c560 first cut at george's ideas on api Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	26	#include "event-id.h"
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	27
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 9 diff changeset	28	namespace ns3 {
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	29
25 9b3bb088c560 first cut at george's ideas on api Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	30	class EventImpl;
9b3bb088c560 first cut at george's ideas on api Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	31
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	32	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	33	* \brief Maintain the event list
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	34	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	35	* This base class specifies the interface used to maintain the
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	36	* event list. If you want to provide a new event list scheduler,
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	37	* you need to create a subclass of this base class and implement
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	38	* all the private pure virtual methods defined here. Namely:
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	39	* - ns3::Scheduler::real_insert
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	40	* - ns3::Scheduler::real_is_empty
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	41	* - ns3::Scheduler::real_peek_next
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	42	* - ns3::Scheduler::real_peek_next_key
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	43	* - ns3::Scheduler::real_remove_next
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	44	* - ns3::Scheduler::real_remove
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	45	* - ns3::Scheduler::real_is_valid
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	46	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	47	* If you need to provide a new event list scheduler without
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	48	* editing the main simulator class, you need to also implement
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	49	* a subclass of the ns3::SchedulerFactory base class and
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	50	* feed it to ns3::Simulator::set_external.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	51	*/
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	52	class Scheduler {
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	53	public:
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	54	struct EventKey {
36 e622fb7a8262 use ns as internal time and export time as ns. Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 25 diff changeset	55	uint64_t m_ns;
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	56	uint32_t m_uid;
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	57	};
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	58	class EventKeyCompare {
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	59	public:
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	60	bool operator () (struct EventKey a, struct EventKey b);
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	61	};
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	62
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	63	virtual ~Scheduler () = 0;
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	64
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	65	EventId insert (EventImpl *event, EventKey key);
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	66	bool is_empty (void) const;
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	67	EventImpl *peek_next (void) const;
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	68	Scheduler::EventKey peek_next_key (void) const ;
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	69	void remove_next (void);
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	70	EventImpl remove (EventId id, EventKey key);
627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	71	bool is_valid (EventId id);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	72
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	73	private:
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	74	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	75	* \param event event to store in the event list
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	76	* \param key timecode associated to this new event
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	77	* \returns an event id which identifies the event inserted
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	78	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	79	* This method takes ownership of the event pointer.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	80	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	81	virtual EventId real_insert (EventImpl *event, EventKey key) = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	82	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	83	* \returns true if the event list is empty and false otherwise.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	84	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	85	virtual bool real_is_empty (void) const = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	86	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	87	* \returns a pointer to the next earliest event. The caller
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	88	* takes ownership of the returned pointer.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	89	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	90	* This method cannot be invoked if the list is empty.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	91	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	92	virtual EventImpl *real_peek_next (void) const = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	93	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	94	* \returns the timecode associated with the next earliest event.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	95	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	96	* This method cannot be invoked if the list is empty.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	97	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	98	virtual Scheduler::EventKey real_peek_next_key (void) const = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	99	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	100	* This method cannot be invoked if the list is empty.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	101	* Remove the next earliest event from the event list.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	102	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	103	virtual void real_remove_next (void) = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	104	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	105	* \param id the id of the event to remove
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	106	* \param key the timecode of the event removed
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	107	* \returns a pointer to the event removed. The caller
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	108	* takes ownership of the returned pointer.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	109	*
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	110	* This methods cannot be invoked if the list is empty.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	111	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	112	virtual EventImpl real_remove (EventId id, EventKey key) = 0;
47 48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	113	/**
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	114	* \param id event id to validate
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	115	* \returns true if the event id identifies an existing valid
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	116	* event stored in the event list and false otherwise.
48cb60c9eeba add documentation for scheduler factory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 46 diff changeset	117	*/
46 627df4c75852 cleanup the Scheduler API Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 36 diff changeset	118	virtual bool real_is_valid (EventId id) = 0;
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	119	};
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	120
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 9 diff changeset	121	}; // namespace ns3
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	122
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	123
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	124	#endif /* SCHEDULER_H */

author	Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
	Mon, 04 Sep 2006 15:52:45 +0200
changeset 47	48cb60c9eeba
parent 46	627df4c75852
child 53	ae406f4957d5
permissions	-rw-r--r--