Rosetta
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

typedef O option_type
 
typedef O::key_type key_type
 
typedef std::size_t size_type
 
typedef O Option
 
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...
 
VariantOption & operator= (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...
 
VariantOption & activate ()
 Activate. More...
 
VariantOption & deactivate ()
 Deactivate. More...
 
VariantOption & clear ()
 Clear. More...
 
VariantOption & cl_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...
 
Option & operator() ()
 Option. More...
 

Private Attributes

Option * option_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

◆ Key

template<typename O >
typedef O::Key utility::options::VariantOption< O >::Key

◆ key_type

template<typename O >
typedef O::key_type utility::options::VariantOption< O >::key_type

◆ Option

template<typename O >
typedef O utility::options::VariantOption< O >::Option

◆ option_type

template<typename O >
typedef O utility::options::VariantOption< O >::option_type

◆ Size

template<typename O >
typedef std::size_t utility::options::VariantOption< O >::Size

◆ size_type

template<typename O >
typedef std::size_t utility::options::VariantOption< O >::size_type

Constructor & Destructor Documentation

◆ VariantOption() [1/3]

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

Default constructor.

◆ VariantOption() [2/3]

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

Copy constructor.

◆ VariantOption() [3/3]

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

Option constructor.

◆ ~VariantOption()

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

Destructor.

References utility::options::VariantOption< O >::option_p_.

Member Function Documentation

◆ activate()

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

Activate.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ active()

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

Active?

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ cl_value()

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

Value assignment from a command line string.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ clear()

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

Clear.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ code()

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

Code.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ deactivate()

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

Deactivate.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ default_size()

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

Default size (number of default values)

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ description()

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

Description.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ id()

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

ID.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

Referenced by schema.Job::__repr__().

◆ identifier()

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

Identifier.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ key()

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

Key.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ n_default_value()

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

Number of default values (default size)

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ n_value()

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

Number of values (size)

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ name()

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

Name.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

Referenced by pyrosetta.distributed.docs.ComponentDoc::__repr__(), options_class.Option::getCName(), options_class.Option::getDoxygenRow(), options_class.Option::getMarkdownRow(), options_class.Option::getOptionKeysCC(), options_class.Option::getWikiTableRow(), enumerate_junctions.DHR::print(), enumerate_junctions.DHR::to_component(), and enumerate_junctions.DHR::write_to_file().

◆ operator Option &()

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

Option conversion.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator Option *()

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

Option conversion.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator Option const &()

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

Option conversion.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator Option const *()

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

Option conversion.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator()() [1/2]

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

Option.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator()() [2/2]

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

Option.

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ operator=()

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

Copy assignment.

References utility::options::VariantOption< O >::option_p_.

◆ size()

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

Size (number of values)

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

◆ user()

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

User-specified?

References utility::options::VariantOption< O >::option_p_, and runtime_assert.

Friends And Related Function Documentation

◆ operator<

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

VariantOption < VariantOption.

Member Data Documentation

◆ option_p_

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

Pointer to option.

Referenced by utility::options::VariantOption< O >::activate(), utility::options::VariantOption< O >::active(), utility::options::VariantOption< O >::cl_value(), utility::options::VariantOption< O >::clear(), utility::options::VariantOption< O >::code(), utility::options::VariantOption< O >::deactivate(), utility::options::VariantOption< O >::default_size(), utility::options::VariantOption< O >::description(), utility::options::VariantOption< O >::id(), utility::options::VariantOption< O >::identifier(), utility::options::VariantOption< O >::key(), utility::options::VariantOption< O >::n_default_value(), utility::options::VariantOption< O >::n_value(), utility::options::VariantOption< O >::name(), utility::options::VariantOption< O >::operator Option &(), utility::options::VariantOption< O >::operator Option *(), utility::options::VariantOption< O >::operator Option const &(), utility::options::VariantOption< O >::operator Option const *(), utility::options::VariantOption< O >::operator()(), utility::options::VariantOption< O >::operator=(), utility::options::VariantOption< O >::size(), utility::options::VariantOption< O >::user(), and utility::options::VariantOption< O >::~VariantOption().

The documentation for this class was generated from the following files:
Generated on Fri Sep 12 2025 00:06:07 for Rosetta by doxygen 1.9.1