Rosetta  2019.31
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | Friends | List of all members
utility::options::OptionKey Class Referenceabstract

Abstract automatic hidden index key for options. More...

#include <OptionKey.hh>

Inheritance diagram for utility::options::OptionKey:
Inheritance graph
[legend]

Public Types

typedef
utility::keys::KeyLookup
< OptionKey
Lookup
 
- Public Types inherited from utility::keys::AutoKey< Option >
typedef utility::keys::Key Key
 
typedef Option object_type
 
typedef std::size_t index_type
 
typedef std::size_t size_type
 
typedef Option Object
 
typedef std::size_t Index
 
typedef std::size_t Size
 

Public Member Functions

virtual OptionKeyclone () const =0
 Clone this. More...
 
virtual ~OptionKey ()
 Destructor. More...
 
OptionKeyoperator= (Key const &key)
 Key assignment. More...
 
virtual bool scalar () const =0
 Scalar option key? More...
 
virtual bool vector () const =0
 Vector option key? More...
 
- Public Member Functions inherited from utility::keys::AutoKey< Option >
virtual ~AutoKey ()
 Destructor. More...
 
AutoKeyoperator= (AutoKey const &key)
 Copy assignment. More...
 
AutoKeyoperator= (Key const &key)
 Key assignment. More...
 
std::string const & id () const
 ID. More...
 
std::string & id ()
 ID. More...
 
AutoKeyid (std::string const &id_a)
 ID assignment. More...
 
std::string const & identifier () const
 Identifier. More...
 
std::string & identifier ()
 Identifier. More...
 
AutoKeyidentifier (std::string const &identifier_a)
 Identifier assignment. More...
 
std::string const & code () const
 Code. More...
 
std::string & code ()
 Code. More...
 
AutoKeycode (std::string const &code_a)
 Code assignment. More...
 
Index private_index () const
 Index. More...
 

Protected Types

typedef utility::keys::Key Key
 

Protected Member Functions

 OptionKey ()
 Default constructor. More...
 
 OptionKey (OptionKey const &key)
 Copy constructor. More...
 
 OptionKey (OptionKey const &key, std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Copy + identifier constructor. More...
 
 OptionKey (Key const &key)
 Key constructor. More...
 
 OptionKey (Key const &key, std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Key + identifier constructor. More...
 
 OptionKey (std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Identifier constructor. More...
 
- Protected Member Functions inherited from utility::keys::AutoKey< Option >
 AutoKey ()
 Default constructor. More...
 
 AutoKey (AutoKey const &key)
 Copy constructor. More...
 
 AutoKey (AutoKey const &key, std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Copy + identifier constructor. More...
 
 AutoKey (Key const &key)
 Key constructor. More...
 
 AutoKey (Key const &key, std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Key + identifier constructor. More...
 
 AutoKey (std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Identifier constructor. More...
 
void assign_Key (Key const &key)
 Key assignment. More...
 
 operator Index () const
 Index value conversion. More...
 
Index index () const
 Index. More...
 
Indexindex ()
 Index. More...
 
AutoKeyindex (Index const index_a)
 Index assignment. More...
 
bool equals (Key const &key) const
 Equal to a Key? More...
 
bool less_than (Key const &key) const
 Less than a Key? More...
 
bool comparable (Key const &key) const
 Comparable to a Key? More...
 

Private Types

typedef utility::keys::AutoKey
< Option
Super
 

Friends

template<typename K , typename T >
class utility::keys::SmallKeyVector
 

Additional Inherited Members

- Static Public Member Functions inherited from utility::keys::AutoKey< Option >
static Size n_key ()
 Number of keys with distinct indexes. More...
 

Detailed Description

Abstract automatic hidden index key for options.

Member Typedef Documentation

Constructor & Destructor Documentation

utility::options::OptionKey::OptionKey ( )
inlineprotected

Default constructor.

utility::options::OptionKey::OptionKey ( OptionKey const &  key)
inlineprotected

Copy constructor.

utility::options::OptionKey::OptionKey ( OptionKey const &  key,
std::string const &  id_a,
std::string const &  identifier_a = std::string(),
std::string const &  code_a = std::string() 
)
inlineprotected

Copy + identifier constructor.

utility::options::OptionKey::OptionKey ( Key const &  key)
inlineexplicitprotected

Key constructor.

utility::options::OptionKey::OptionKey ( Key const &  key,
std::string const &  id_a,
std::string const &  identifier_a = std::string(),
std::string const &  code_a = std::string() 
)
inlineprotected

Key + identifier constructor.

utility::options::OptionKey::OptionKey ( std::string const &  id_a,
std::string const &  identifier_a = std::string(),
std::string const &  code_a = std::string() 
)
inlineexplicitprotected

Identifier constructor.

virtual utility::options::OptionKey::~OptionKey ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual OptionKey* utility::options::OptionKey::clone ( ) const
pure virtual
OptionKey& utility::options::OptionKey::operator= ( Key const &  key)
inline
virtual bool utility::options::OptionKey::scalar ( ) const
pure virtual
virtual bool utility::options::OptionKey::vector ( ) const
pure virtual

Friends And Related Function Documentation

template<typename K , typename T >
friend class utility::keys::SmallKeyVector
friend

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