--- a/src/core/trace-context-element.h Tue Aug 28 14:51:13 2007 +0200
+++ b/src/core/trace-context-element.h Tue Aug 28 15:04:37 2007 +0200
@@ -48,6 +48,7 @@
* MyContext ();
* ~MyContext ();
* void Print (std::ostream &os) const;
+ * std::string GetName (void) const;
*
* // the user-specific API to manipulate the context.
* void SetData (uint8_t data);
@@ -71,6 +72,11 @@
* {
* os << "mycontext=" << (uint32_t) m_myContextData;
* }
+ * std::string
+ * MyContext::GetName (void) const
+ * {
+ * return "MyContext";
+ * }
* void
* MyContext::SetData (uint8_t data)
* {
--- a/src/core/trace-source.h Tue Aug 28 14:51:13 2007 +0200
+++ b/src/core/trace-source.h Tue Aug 28 15:04:37 2007 +0200
@@ -23,11 +23,26 @@
namespace ns3 {
+/**
+ * \brief the base class for all trace sources
+ *
+ * Every trace source which wishes to be connectable and disconnectable with
+ * the TraceResolver system should derive from this base class and implement
+ * all three methods below.
+ */
class TraceSource
{
public:
virtual ~TraceSource () {}
+ /**
+ * \param callback the callback to connect to this trace source
+ * \param the context associated to the input callback which should be passed
+ * back to the user.
+ */
virtual void AddCallback (CallbackBase const & callback, TraceContext const & context) = 0;
+ /**
+ * \param callback the callback to disconnect from this trace source
+ */
virtual void RemoveCallback (CallbackBase const & callback) = 0;
};