ns-3.5: src/core/object-factory.h@c09faa6c90bf (annotated)

2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	1	#ifndef OBJECT_FACTORY_H
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	2	#define OBJECT_FACTORY_H
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	3
2438 e2ac9f9aeeb9 value.h -> attribute.h Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2433 diff changeset	4	#include "attribute.h"
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	5	#include "object.h"
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	6
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	7	namespace ns3 {
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	8
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	9	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	10	* \brief instantiate subclasses of ns3::Object.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	11	*
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	12	* This class can also hold a set of attributes to set
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	13	* automatically during the object construction.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	14	*/
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	15	class ObjectFactory
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	16	{
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	17	public:
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	18	ObjectFactory ();
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	19
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	20	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	21	* \param tid the TypeId of the object to instantiate.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	22	*/
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	23	void SetTypeId (TypeId tid);
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	24	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	25	* \param tid the TypeId of the object to instantiate.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	26	*/
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	27	void SetTypeId (const char *tid);
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	28	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	29	* \param tid the TypeId of the object to instantiate.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	30	*/
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	31	void SetTypeId (std::string tid);
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	32	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	33	* \param name the name of the attribute to set during object construction
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	34	* \param value the value of the attribute to set during object construction
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	35	*/
2433 3a98e1db7f80 PValue -> Attribute Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2395 diff changeset	36	void Set (std::string name, Attribute value);
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	37
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	38	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	39	* \returns the currently-selected TypeId to use to create an object
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	40	* instance.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	41	*/
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	42	TypeId GetTypeId (void) const;
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	43
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	44	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	45	* \returns a new object instance.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	46	*/
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	47	Ptr<Object> Create (void) const;
2583 c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	48	/**
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	49	* \returns a new object instance.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	50	*
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	51	* This method performs an extra call to ns3::Object::GetObject before
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	52	* returning a pointer of the requested type to the user. This method
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	53	* is really syntactical sugar.
c09faa6c90bf doxygen doc Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2582 diff changeset	54	*/
2483 a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	55	template <typename T>
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	56	Ptr<T> Create (void) const;
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	57
2582 3e28107b870f rename old VALUE leftovers Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2555 diff changeset	58	ATTRIBUTE_HELPER_HEADER_1 (ObjectFactory);
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	59	private:
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	60	TypeId m_tid;
2459 91662d921a83 Attributes -> AttributeList Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2458 diff changeset	61	AttributeList m_parameters;
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	62	};
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	63
2555 469bcb4d0010 give Attribute power to ObjectFactory class. Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2507 diff changeset	64	std::ostream & operator << (std::ostream &os, const ObjectFactory &factory);
469bcb4d0010 give Attribute power to ObjectFactory class. Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2507 diff changeset	65	std::istream & operator >> (std::istream &is, ObjectFactory &factory);
469bcb4d0010 give Attribute power to ObjectFactory class. Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2507 diff changeset	66
2582 3e28107b870f rename old VALUE leftovers Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2555 diff changeset	67	ATTRIBUTE_HELPER_HEADER_2 (ObjectFactory);
2555 469bcb4d0010 give Attribute power to ObjectFactory class. Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2507 diff changeset	68
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	69	} // namespace ns3
ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	70
2483 a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	71	namespace ns3 {
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	72
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	73	template <typename T>
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	74	Ptr<T>
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	75	ObjectFactory::Create (void) const
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	76	{
2507 092b9687568d Use a temporary to avoid confusing the compiler. Mathieu Lacage <Mathieu.Lacage@sophia.inria.fr> parents: 2502 diff changeset	77	Ptr<Object> object = Create ();
092b9687568d Use a temporary to avoid confusing the compiler. Mathieu Lacage <Mathieu.Lacage@sophia.inria.fr> parents: 2502 diff changeset	78	return object->GetObject<T> ();
2483 a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	79	}
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	80
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	81	} // namespace ns3
a6097b0414b3 add templated version of ObjectFactory::Create Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 2459 diff changeset	82
2395 ffd1c96afe4b a pretty simple wrapper around TypeId+Parameters: ObjectFactory Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	83	#endif /* OBJECT_FACTORY_H */

author	Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
	Mon, 10 Mar 2008 13:09:32 -0700
changeset 2583	c09faa6c90bf
parent 2582	3e28107b870f
child 2586	50d78910a997
permissions	-rw-r--r--