Rosetta  2019.47
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
utility::options::VariantOption< O > Class Template Reference

Variant option class. More...

#include <VariantOption.hh>

Public Types

typedefoption_type
 
typedef O::key_type key_type
 
typedef std::size_t size_type
 
typedefOption
 
typedef O::Key Key
 
typedef std::size_t Size
 

Public Member Functions

 VariantOption ()
 Default constructor. More...
 
 VariantOption (VariantOption const &var)
 Copy constructor. More...
 
 VariantOption (Option const &option_a)
 Option constructor. More...
 
 ~VariantOption () throw ()
 Destructor. More...
 
VariantOptionoperator= (VariantOption const &var)
 Copy assignment. More...
 
 operator Option const & () const
 Option conversion. More...
 
 operator Option & ()
 Option conversion. More...
 
 operator Option const * () const
 Option conversion. More...
 
 operator Option * ()
 Option conversion. More...
 
VariantOptionactivate ()
 Activate. More...
 
VariantOptiondeactivate ()
 Deactivate. More...
 
VariantOptionclear ()
 Clear. More...
 
VariantOptioncl_value (std::string const &value_str)
 Value assignment from a command line string. More...
 
Key const & key () const
 Key. More...
 
std::string const & id () const
 ID. More...
 
std::string const & identifier () const
 Identifier. More...
 
std::string const & code () const
 Code. More...
 
std::string const & name () const
 Name. More...
 
std::string const & description () const
 Description. More...
 
bool active () const
 Active? More...
 
bool user () const
 User-specified? More...
 
Size default_size () const
 Default size (number of default values) More...
 
Size n_default_value () const
 Number of default values (default size) More...
 
Size size () const
 Size (number of values) More...
 
Size n_value () const
 Number of values (size) More...
 
Option const & operator() () const
 Option. More...
 
Optionoperator() ()
 Option. More...
 

Private Attributes

Optionoption_p_
 Pointer to option. More...
 

Friends

bool operator< (VariantOption const &a, VariantOption const &b)
 VariantOption < VariantOption. More...
 

Detailed Description

template<typename O>
class utility::options::VariantOption< O >

Variant option class.

Member Typedef Documentation

template<typename O>
typedef O::Key utility::options::VariantOption< O >::Key
template<typename O>
typedef O::key_type utility::options::VariantOption< O >::key_type
template<typename O>
typedef O utility::options::VariantOption< O >::Option
template<typename O>
typedef O utility::options::VariantOption< O >::option_type
template<typename O>
typedef std::size_t utility::options::VariantOption< O >::Size
template<typename O>
typedef std::size_t utility::options::VariantOption< O >::size_type

Constructor & Destructor Documentation

template<typename O>
utility::options::VariantOption< O >::VariantOption ( )
inline

Default constructor.

template<typename O>
utility::options::VariantOption< O >::VariantOption ( VariantOption< O > const &  var)
inline

Copy constructor.

template<typename O>
utility::options::VariantOption< O >::VariantOption ( Option const &  option_a)
inline

Option constructor.

template<typename O>
utility::options::VariantOption< O >::~VariantOption ( )
throw (
)
inline

Destructor.

Member Function Documentation

template<typename O>
VariantOption& utility::options::VariantOption< O >::activate ( )
inline

Activate.

template<typename O>
bool utility::options::VariantOption< O >::active ( ) const
inline

Active?

template<typename O>
VariantOption& utility::options::VariantOption< O >::cl_value ( std::string const &  value_str)
inline

Value assignment from a command line string.

template<typename O>
VariantOption& utility::options::VariantOption< O >::clear ( )
inline

Clear.

template<typename O>
std::string const& utility::options::VariantOption< O >::code ( ) const
inline

Code.

template<typename O>
VariantOption& utility::options::VariantOption< O >::deactivate ( )
inline

Deactivate.

template<typename O>
Size utility::options::VariantOption< O >::default_size ( ) const
inline

Default size (number of default values)

template<typename O>
std::string const& utility::options::VariantOption< O >::description ( ) const
inline

Description.

template<typename O>
std::string const& utility::options::VariantOption< O >::id ( ) const
inline

ID.

template<typename O>
std::string const& utility::options::VariantOption< O >::identifier ( ) const
inline

Identifier.

template<typename O>
Key const& utility::options::VariantOption< O >::key ( ) const
inline

Key.

template<typename O>
Size utility::options::VariantOption< O >::n_default_value ( ) const
inline

Number of default values (default size)

template<typename O>
Size utility::options::VariantOption< O >::n_value ( ) const
inline

Number of values (size)

template<typename O>
std::string const& utility::options::VariantOption< O >::name ( ) const
inline

Name.

template<typename O>
utility::options::VariantOption< O >::operator Option & ( )
inline

Option conversion.

template<typename O>
utility::options::VariantOption< O >::operator Option * ( )
inline

Option conversion.

template<typename O>
utility::options::VariantOption< O >::operator Option const & ( ) const
inline

Option conversion.

template<typename O>
utility::options::VariantOption< O >::operator Option const * ( ) const
inline

Option conversion.

template<typename O>
Option const& utility::options::VariantOption< O >::operator() ( ) const
inline
template<typename O>
Option& utility::options::VariantOption< O >::operator() ( )
inline
template<typename O>
VariantOption& utility::options::VariantOption< O >::operator= ( VariantOption< O > const &  var)
inline

Copy assignment.

template<typename O>
Size utility::options::VariantOption< O >::size ( ) const
inline

Size (number of values)

template<typename O>
bool utility::options::VariantOption< O >::user ( ) const
inline

User-specified?

Friends And Related Function Documentation

template<typename O>
bool operator< ( VariantOption< O > const &  a,
VariantOption< O > const &  b 
)
friend

Member Data Documentation

template<typename O>
Option* utility::options::VariantOption< O >::option_p_
private

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