Rosetta  2019.40
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Types | Friends | List of all members
utility::options::StringOptionKey Class Reference

Automatic hidden index key for string options. More...

#include <StringOptionKey.hh>

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

Public Member Functions

 StringOptionKey ()
 Default constructor. More...
 
 StringOptionKey (StringOptionKey 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...
 
 StringOptionKey (Key const &key)
 Key constructor. More...
 
 StringOptionKey (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...
 
 StringOptionKey (std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Identifier constructor. More...
 
StringOptionKeyclone () const override
 Clone this. More...
 
 ~StringOptionKey () override
 Destructor. More...
 
StringOptionKeyoperator= (Key const &key)
 Key assignment. More...
 
- Public Member Functions inherited from utility::options::ScalarOptionKey
 ~ScalarOptionKey () override
 Destructor. More...
 
ScalarOptionKeyoperator= (Key const &key)
 Key assignment. More...
 
bool scalar () const override
 Scalar option key? More...
 
bool vector () const override
 Vector option key? More...
 
- Public Member Functions inherited from utility::options::OptionKey
 ~OptionKey () override
 Destructor. More...
 
OptionKeyoperator= (Key const &key)
 Key assignment. More...
 
- Public Member Functions inherited from utility::keys::AutoKey< Option >
 ~AutoKey () override
 Destructor. More...
 
AutoKeyoperator= (AutoKey const &key)
 Copy assignment. More...
 
AutoKeyoperator= (Key const &key)
 Key assignment. More...
 
std::string const & id () const override
 ID. More...
 
std::string & id () override
 ID. More...
 
AutoKeyid (std::string const &id_a) override
 ID assignment. More...
 
std::string const & identifier () const override
 Identifier. More...
 
std::string & identifier () override
 Identifier. More...
 
AutoKeyidentifier (std::string const &identifier_a) override
 Identifier assignment. More...
 
std::string const & code () const override
 Code. More...
 
std::string & code () override
 Code. More...
 
AutoKeycode (std::string const &code_a) override
 Code assignment. More...
 
Index private_index () const override
 Index. More...
 

Private Types

typedef ScalarOptionKey Super
 

Friends

class utility::keys::SmallKeyVector< StringOptionKey, StringOption >
 

Additional Inherited Members

- Public Types inherited from utility::options::OptionKey
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
 
- Static Public Member Functions inherited from utility::keys::AutoKey< Option >
static Size n_key ()
 Number of keys with distinct indexes. More...
 
- Protected Types inherited from utility::options::OptionKey
typedef utility::keys::Key Key
 
- Protected Member Functions inherited from utility::options::ScalarOptionKey
 ScalarOptionKey ()
 Default constructor. More...
 
 ScalarOptionKey (ScalarOptionKey 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...
 
 ScalarOptionKey (Key const &key)
 Key constructor. More...
 
 ScalarOptionKey (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...
 
 ScalarOptionKey (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::options::OptionKey
 OptionKey ()
 Default 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) override
 Key assignment. More...
 
 operator Index () const
 Index value conversion. More...
 
Index index () const override
 Index. More...
 
Indexindex () override
 Index. More...
 
AutoKeyindex (Index const index_a) override
 Index assignment. More...
 
bool equals (Key const &key) const override
 Equal to a Key? More...
 
bool less_than (Key const &key) const override
 Less than a Key? More...
 
bool comparable (Key const &key) const override
 Comparable to a Key? More...
 

Detailed Description

Automatic hidden index key for string options.

Member Typedef Documentation

Constructor & Destructor Documentation

utility::options::StringOptionKey::StringOptionKey ( )
inline

Default constructor.

Referenced by clone().

utility::options::StringOptionKey::StringOptionKey ( StringOptionKey const &  key,
std::string const &  id_a,
std::string const &  identifier_a = std::string(),
std::string const &  code_a = std::string() 
)
inline

Copy + identifier constructor.

References utility::keys::KeyLookup< K >::add().

utility::options::StringOptionKey::StringOptionKey ( Key const &  key)
inlineexplicit

Key constructor.

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

Key + identifier constructor.

References utility::keys::KeyLookup< K >::add().

utility::options::StringOptionKey::StringOptionKey ( std::string const &  id_a,
std::string const &  identifier_a = std::string(),
std::string const &  code_a = std::string() 
)
inlineexplicit

Identifier constructor.

References utility::keys::KeyLookup< K >::add().

utility::options::StringOptionKey::~StringOptionKey ( )
inlineoverride

Destructor.

Member Function Documentation

StringOptionKey* utility::options::StringOptionKey::clone ( ) const
inlineoverridevirtual
StringOptionKey& utility::options::StringOptionKey::operator= ( Key const &  key)
inline

Friends And Related Function Documentation


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