Home | Libraries | People | FAQ | More |
boost::program_options::typed_value —
template<typename T, typename charT = char> class typed_value : : public boost::program_options::value_semantic_codecvt_helper< charT > { public: // construct/copy/destruct typed_value(T *); // public member functions typed_value * default_value(const T &) ; typed_value * default_value(const T &, const std::string &) ; typed_value * notifier(function1< void, const T & >) ; typed_value * composing() ; typed_value * implicit() ; typed_value * multitoken() ; typed_value * zero_tokens() ; std::string name() const; bool is_zero_tokens() const; bool is_composing() const; bool is_implicit() const; bool is_multitoken() const; void xparse(boost::any &, const std::vector< std::basic_string< charT > > &) const; virtual bool apply_default(boost::any &) const; void notify(const boost::any &) const; };
Class which handles value of a specific type.
typed_value * default_value(const T & v) ;
Specifies default value, which will be used if none is explicitly specified. The type 'T' should provide operator<< for ostream.
typed_value * default_value(const T & v, const std::string & textual) ;
Specifies default value, which will be used if none is explicitly specified. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user.
typed_value * notifier(function1< void, const T & > f) ;
Specifies a function to be called when the final value is determined.
typed_value * composing() ;
Specifies that the value is composing. See the 'is_composing' method for explanation.
typed_value * implicit() ;
Specifies that the value is implicit.
typed_value * multitoken() ;
Specifies that the value can span multiple tokens.
typed_value * zero_tokens() ;
std::string name() const;
bool is_zero_tokens() const;
bool is_composing() const;
bool is_implicit() const;
bool is_multitoken() const;
void xparse(boost::any & value_store, const std::vector< std::basic_string< charT > > & new_tokens) const;
Creates an instance of the 'validator' class and calls its operator() to perform athe ctual conversion.
virtual bool apply_default(boost::any & value_store) const;
If default value was specified via previous call to 'default_value', stores that value into 'value_store'. Returns true if default value was stored.
void notify(const boost::any & value_store) const;
If an address of variable to store value was specified when creating *this, stores the value there. Otherwise, does nothing.
Copyright © 2002-2004 Vladimir Prus |