X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FVariables.hh;h=a732b41f9decd131c27abf18d15b0e588bbaceda;hb=fc1569e67cfda71bc8c406617a5e0b05f28f1b47;hp=92df05dd87262e678d0b439602e7b2103f6c2479;hpb=f13780e9e4da7df981d6f6542fbdc714beb34765;p=senf.git diff --git a/senf/Utils/Console/Variables.hh b/senf/Utils/Console/Variables.hh index 92df05d..a732b41 100644 --- a/senf/Utils/Console/Variables.hh +++ b/senf/Utils/Console/Variables.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2008 +// Copyright (C) 2008 // Fraunhofer Institute for Open Communication Systems (FOKUS) // Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund @@ -30,7 +30,7 @@ #include #include #include -#include "ParsedCommand.hh" +#include "Node.hh" #include "Variables.ih" //#include "Variables.mpp" @@ -45,7 +45,7 @@ namespace console { namespace factory { /** \brief Variable command attributes (const) - + \see VariableFactory */ template @@ -63,7 +63,7 @@ namespace factory { ConstVariableFactory formatter(Formatter formatter); OverloadedCommandNode & create(DirectoryNode & dir, std::string const & name) const; - + explicit ConstVariableFactory(Variable const & var); private: @@ -71,7 +71,7 @@ namespace factory { boost::optional doc_; boost::optional shortdoc_; }; - + /** \brief Variable command attributes Variable commands allow to register any arbitrary variable as a command node. The variable @@ -82,7 +82,7 @@ namespace factory { int var; ScopedDirectory<> dir; - dir.add("var", var); + dir.add("var", fty::Variable(var)); \endcode Variables should be registered only with a ScopedDirectory declared in the same scope @@ -91,13 +91,13 @@ namespace factory { Since a variable command is added as a combination of two ordinary overloads, it is possible to register additional overloads with the same name before or after registering the - variable. + variable. It is also possible, to register a variable read-only. To achieve this, just wrap it with \c boost::cref(). Such a variable cannot be changed only queried. Therefore, it does not have the parser() and typeName() attributes. \code - dir.add("const_var", boost::cref(var)) + dir.add("const_var", fty::Variable(boost::cref(var))); \endcode \ingroup console_commands @@ -130,7 +130,7 @@ namespace factory { \code void parser(senf::console::ParseCommandInfo::TokensRange const & tokens, value_type & out); \endcode - + where \c value_type is the type of the overload parameter. The parser must read and parse the complete \a tokens range and return the parsed value in \a