boost::program_options::value_semantic_codecvt_helper< char > Class Template Reference

Helper conversion class for values that accept ascii strings as input. More...

#include <value_semantic.hpp>

Inheritance diagram for boost::program_options::value_semantic_codecvt_helper< char >:

Collaboration diagram for boost::program_options::value_semantic_codecvt_helper< char >:

Public Member Functions
virtual std::string	name () const =0
	Returns the name of the option. More...
virtual unsigned	min_tokens () const =0
	The minimum number of tokens for this option that should be present on the command line. More...
virtual unsigned	max_tokens () const =0
	The maximum number of tokens for this option that should be present on the command line. More...
virtual bool	is_composing () const =0
	Returns true if values from different sources should be composed. More...
virtual bool	is_required () const =0
	Returns true if value must be given. More...
virtual bool	apply_default (boost::any &value_store) const =0
	Called to assign default value to 'value_store'. More...
virtual void	notify (const boost::any &value_store) const =0
	Called when final value of an option is determined. More...

Protected Member Functions
virtual void	xparse (boost::any &value_store, const std::vector< std::string > &new_tokens) const =0

Detailed Description

template<>
class boost::program_options::value_semantic_codecvt_helper< char >

Helper conversion class for values that accept ascii strings as input.

Overrides the 'parse' method and defines new 'xparse' method taking std::string. Depending on whether input to parse is ascii or UTF8, will pass it to xparse unmodified, or with UTF8->ascii conversion.

Member Function Documentation

virtual bool boost::program_options::value_semantic::apply_default ( boost::any &  value_store ) const

pure virtualinherited

Called to assign default value to 'value_store'.

Returns true if default value is assigned, and false if no default value exists.

Implemented in boost::program_options::untyped_value.

virtual bool boost::program_options::value_semantic::is_composing ( ) const

pure virtualinherited

Returns true if values from different sources should be composed.

Otherwise, value from the first source is used and values from other sources are discarded.

Implemented in boost::program_options::untyped_value.

virtual bool boost::program_options::value_semantic::is_required ( ) const

pure virtualinherited

Returns true if value must be given.

Non-optional value

Implemented in boost::program_options::untyped_value.

virtual unsigned boost::program_options::value_semantic::max_tokens ( ) const

pure virtualinherited

The maximum number of tokens for this option that should be present on the command line.

Implemented in boost::program_options::untyped_value.

virtual unsigned boost::program_options::value_semantic::min_tokens ( ) const

pure virtualinherited

The minimum number of tokens for this option that should be present on the command line.

Implemented in boost::program_options::untyped_value.

virtual std::string boost::program_options::value_semantic::name ( ) const

pure virtualinherited

Returns the name of the option.

The name is only meaningful for automatic help message.

Implemented in boost::program_options::untyped_value.

virtual void boost::program_options::value_semantic::notify ( const boost::any &  value_store ) const

pure virtualinherited

Called when final value of an option is determined.

Implemented in boost::program_options::untyped_value.

virtual void boost::program_options::value_semantic_codecvt_helper< char >::xparse ( boost::any &  value_store, const std::vector< std::string > &  new_tokens  ) const

protectedpure virtual

Implemented in boost::program_options::untyped_value.

---

The documentation for this class was generated from the following file:

• boost_1_57_0/boost/program_options/value_semantic.hpp