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

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

#include <FileOptionKey.hh>

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

Public Member Functions

 FileOptionKey ()
 Default constructor. More...
 
 FileOptionKey (FileOptionKey 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...
 
 FileOptionKey (Key const &key)
 Key constructor. More...
 
 FileOptionKey (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...
 
 FileOptionKey (std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
 Identifier constructor. More...
 
FileOptionKeyclone () const
 Clone this. More...
 
virtual ~FileOptionKey ()
 Destructor. More...
 
FileOptionKeyoperator= (Key const &key)
 Key assignment. More...
 
- Public Member Functions inherited from utility::options::ScalarOptionKey
virtual ~ScalarOptionKey ()
 Destructor. More...
 
ScalarOptionKeyoperator= (Key const &key)
 Key assignment. More...
 
bool scalar () const
 Scalar option key? More...
 
bool vector () const
 Vector option key? More...
 
- Public Member Functions inherited from utility::options::OptionKey
virtual ~OptionKey ()
 Destructor. More...
 
OptionKeyoperator= (Key const &key)
 Key assignment. 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...
 

Private Types

typedef ScalarOptionKey Super
 

Friends

class utility::keys::SmallKeyVector< FileOptionKey, FileOption >
 

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)
 Copy 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)
 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...
 

Detailed Description

Automatic hidden index key for file options.

Member Typedef Documentation

Constructor & Destructor Documentation

utility::options::FileOptionKey::FileOptionKey ( )
inline

Default constructor.

Referenced by clone().

utility::options::FileOptionKey::FileOptionKey ( FileOptionKey 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::FileOptionKey::FileOptionKey ( Key const &  key)
inlineexplicit

Key constructor.

utility::options::FileOptionKey::FileOptionKey ( 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::FileOptionKey::FileOptionKey ( 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().

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

Destructor.

Member Function Documentation

FileOptionKey* utility::options::FileOptionKey::clone ( ) const
inlinevirtual

Clone this.

Implements utility::options::ScalarOptionKey.

References FileOptionKey().

FileOptionKey& utility::options::FileOptionKey::operator= ( Key const &  key)
inline

Friends And Related Function Documentation


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