X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FLogger%2FAreaRegistry.hh;h=82a43ed865f887faf75db3f355de1098c3069dc1;hb=61dc3812717cdc89fa2402006d4009236b72dc8f;hp=6dd3d302f6374872affcfdfbdc4d5b1e996a5ebb;hpb=61419d9a2e1060f7ede22fa19fd9d0b401bbc87a;p=senf.git diff --git a/Utils/Logger/AreaRegistry.hh b/Utils/Logger/AreaRegistry.hh index 6dd3d30..82a43ed 100644 --- a/Utils/Logger/AreaRegistry.hh +++ b/Utils/Logger/AreaRegistry.hh @@ -1,8 +1,8 @@ // $Id$ // -// Copyright (C) 2007 -// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) -// Kompetenzzentrum fuer Satelitenkommunikation (SatCom) +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund // // This program is free software; you can redistribute it and/or modify @@ -23,8 +23,8 @@ /** \file \brief AreaRegistry public header */ -#ifndef HH_AreaRegistry_ -#define HH_AreaRegistry_ 1 +#ifndef HH_SENF_Utils_Logger_AreaRegistry_ +#define HH_SENF_Utils_Logger_AreaRegistry_ 1 // Custom includes #include @@ -43,11 +43,13 @@ namespace log { /** \brief Area registry - The area registry keeps track of all areas defined. Area classes are defined as singletons - and will automatically register with this registry. + The area registry keeps track of all areas defined. - The area registry exposes a forward sequence interface which is a sequence of the names of - all registered areas. + The area registry exposes a forward sequence interface which allows to query the list of all + registered areas. + + \implementation Area classes are defined as singletons and will automatically register with + this registry. */ class AreaRegistry : public senf::singleton @@ -62,6 +64,7 @@ namespace log { public: typedef boost::transform_iterator iterator; + ///< Iterator type # ifdef DOXYGEN // Hmm ... doxygen does not understand using declarations ... @@ -71,8 +74,10 @@ namespace log { using senf::singleton::instance; - iterator begin(); - iterator end(); + iterator begin(); ///< Beginning of area name sequence + iterator end(); ///< End of area name sequence + + detail::AreaBase const * lookup(std::string const & name); private: AreaRegistry();