utility::keys::AutoKey< O, S, C > Class Template Reference

Automatic hidden index key abstract base class. More...

#include <AutoKey.hh>

Inheritance diagram for utility::keys::AutoKey< O, S, C >:

Public Types
typedef utility::keys::Key	Key
typedef O	object_type
typedef std::size_t	index_type
typedef std::size_t	size_type
typedef O	Object
typedef std::size_t	Index
typedef std::size_t	Size
Public Types inherited from S
typedef struct S::_D	D

Public Member Functions
AutoKey *	clone () const override=0
	Clone this. More...
	~AutoKey () override
	Destructor. More...
AutoKey &	operator= (AutoKey const &key)
	Copy assignment. More...
AutoKey &	operator= (Key const &key)
	Key assignment. More...
std::string const &	id () const override
	ID. More...
std::string &	id () override
	ID. More...
AutoKey &	id (std::string const &id_a) override
	ID assignment. More...
std::string const &	identifier () const override
	Identifier. More...
std::string &	identifier () override
	Identifier. More...
AutoKey &	identifier (std::string const &identifier_a) override
	Identifier assignment. More...
std::string const &	code () const override
	Code. More...
std::string &	code () override
	Code. More...
AutoKey &	code (std::string const &code_a) override
	Code assignment. More...
Index	private_index () const override
	Index. More...

Static Public Member Functions
static Size	n_key ()
	Number of keys with distinct indexes. More...

Protected Member Functions
	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...
Index &	index () override
	Index. More...
AutoKey &	index (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...

Private Types
typedef S	Super

Static Private Member Functions
static Size &	n_key_ ()
	Number of keys with distinct indexes. More...
static Size	next_index ()
	Increment the index counter and return it. More...

Private Attributes
Index	index_
	Index. More...
std::string	id_
	ID: Short identifier. More...
std::string	identifier_
	Identifier: Long identifier. More...
std::string	code_
	Code: Coded identifier. More...

Friends
bool	operator== (AutoKey const &a, AutoKey const &b)
	AutoKey == AutoKey. More...
bool	operator!= (AutoKey const &a, AutoKey const &b)
	AutoKey != AutoKey. More...
bool	operator< (AutoKey const &a, AutoKey const &b)
	AutoKey < AutoKey. More...
bool	operator<= (AutoKey const &a, AutoKey const &b)
	AutoKey <= AutoKey. More...
bool	operator>= (AutoKey const &a, AutoKey const &b)
	AutoKey >= AutoKey. More...
bool	operator> (AutoKey const &a, AutoKey const &b)
	AutoKey > AutoKey. More...
template<typename UO , typename US , typename UC >
bool	sequential (AutoKey< UO, US, UC > const &a, AutoKey< UO, US, UC > const &b)
	AutoKeys are sequential? More...

Additional Inherited Members
Public Attributes inherited from S
int	a
struct {
int   b
};
FL_not_binded	fl
struct {
float   b4
}	B_not_binded [4]
struct {
int   c
}	C_not_binded

Detailed Description

template<typename O, typename S = Key, typename C = NoClient>
class utility::keys::AutoKey< O, S, C >

Automatic hidden index key abstract base class.

Member Typedef Documentation

template<typename O, typename S = Key, typename C = NoClient>

typedef std::size_t utility::keys::AutoKey< O, S, C >::Index

template<typename O, typename S = Key, typename C = NoClient>

typedef std::size_t utility::keys::AutoKey< O, S, C >::index_type

template<typename O, typename S = Key, typename C = NoClient>

typedef utility::keys::Key utility::keys::AutoKey< O, S, C >::Key

template<typename O, typename S = Key, typename C = NoClient>

typedef O utility::keys::AutoKey< O, S, C >::Object

template<typename O, typename S = Key, typename C = NoClient>

typedef O utility::keys::AutoKey< O, S, C >::object_type

template<typename O, typename S = Key, typename C = NoClient>

typedef std::size_t utility::keys::AutoKey< O, S, C >::Size

template<typename O, typename S = Key, typename C = NoClient>

typedef std::size_t utility::keys::AutoKey< O, S, C >::size_type

template<typename O, typename S = Key, typename C = NoClient>

typedef S utility::keys::AutoKey< O, S, C >::Super

private

Constructor & Destructor Documentation

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( )

inlineprotected

Default constructor.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( AutoKey< O, S, C > const &  key )

inlineprotected

Copy constructor.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( AutoKey< O, S, C > 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.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( Key const &  key )

inlineexplicitprotected

Key constructor.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( 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.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::AutoKey ( std::string const &  id_a, std::string const &  identifier_a = std::string(), std::string const &  code_a = std::string()  )

inlineexplicitprotected

Identifier constructor.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::~AutoKey ( )

inlineoverride

Destructor.

Member Function Documentation

template<typename O, typename S = Key, typename C = NoClient>

void utility::keys::AutoKey< O, S, C >::assign_Key ( Key const &  key )

inlineoverrideprotected

Key assignment.

Referenced by utility::keys::AutoKey< Option >::operator=().

template<typename O, typename S = Key, typename C = NoClient>

AutoKey* utility::keys::AutoKey< O, S, C >::clone ( ) const

overridepure virtual

Clone this.

Implemented in utility::options::OptionKey, utility::options::AnyOptionKey, utility::options::AnyVectorOptionKey, utility::options::BooleanOptionKey, utility::options::BooleanVectorOptionKey, utility::options::FileOptionKey, utility::options::FileVectorOptionKey, utility::options::IntegerOptionKey, utility::options::IntegerVectorOptionKey, utility::options::PathOptionKey, utility::options::PathVectorOptionKey, utility::options::RealOptionKey, utility::options::RealVectorOptionKey, utility::options::ResidueChainVectorOptionKey, utility::options::StringOptionKey, utility::options::StringVectorOptionKey, utility::options::ScalarOptionKey, and utility::options::VectorOptionKey.

template<typename O, typename S = Key, typename C = NoClient>

std::string const& utility::keys::AutoKey< O, S, C >::code ( ) const

inlineoverride

Code.

Referenced by utility::options::OptionCollection::check_key(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::code(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::code(), binder::Context::create_all_nested_namespaces(), and utility::options::OptionCollection::find_key_cl().

template<typename O, typename S = Key, typename C = NoClient>

std::string& utility::keys::AutoKey< O, S, C >::code ( )

inlineoverride

Code.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::code ( std::string const &  code_a )

inlineoverride

Code assignment.

template<typename O, typename S = Key, typename C = NoClient>

bool utility::keys::AutoKey< O, S, C >::comparable ( Key const &  key ) const

inlineoverrideprotected

Comparable to a Key?

Referenced by utility::keys::AutoKey< Option >::assign_Key().

template<typename O, typename S = Key, typename C = NoClient>

bool utility::keys::AutoKey< O, S, C >::equals ( Key const &  key ) const

inlineoverrideprotected

Equal to a Key?

template<typename O, typename S = Key, typename C = NoClient>

std::string const& utility::keys::AutoKey< O, S, C >::id ( ) const

inlineoverride

ID.

Referenced by basic::options::add_anonymous_option(), utility::options::OptionCollection::check_key(), utility::options::OptionCollection::find_key_cl(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::id(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::id(), basic::options::int2afteroption(), basic::options::intafteroption(), utility::options::OptionCollection::is_relevant(), main(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::name(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::name(), basic::options::optional_positive_intafteroption(), basic::options::real2afteroption(), basic::options::real3afteroption(), basic::options::realafteroption(), utility::options::OptionCollection::set_option_value_cl(), utility::options::OptionCollection::set_option_value_file(), basic::resource_manager::show_option_map(), basic::resource_manager::show_option_vector_map(), basic::options::stringafteroption(), and basic::options::truefalseoption().

template<typename O, typename S = Key, typename C = NoClient>

std::string& utility::keys::AutoKey< O, S, C >::id ( )

inlineoverride

ID.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::id ( std::string const &  id_a )

inlineoverride

ID assignment.

template<typename O, typename S = Key, typename C = NoClient>

std::string const& utility::keys::AutoKey< O, S, C >::identifier ( ) const

inlineoverride

Identifier.

Referenced by utility::options::OptionCollection::check_key(), utility::options::OptionCollection::find_key_cl(), utility::options::ScalarOption_T_< PathOptionKey, file::PathName >::identifier(), utility::options::VectorOption_T_< BooleanVectorOptionKey, bool >::identifier(), and basic::options::replace_option_namespace_colons_with_underscores().

template<typename O, typename S = Key, typename C = NoClient>

std::string& utility::keys::AutoKey< O, S, C >::identifier ( )

inlineoverride

Identifier.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::identifier ( std::string const &  identifier_a )

inlineoverride

Identifier assignment.

template<typename O, typename S = Key, typename C = NoClient>

Index utility::keys::AutoKey< O, S, C >::index ( ) const

inlineoverrideprotected

Index.

template<typename O, typename S = Key, typename C = NoClient>

Index& utility::keys::AutoKey< O, S, C >::index ( )

inlineoverrideprotected

Index.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::index ( Index const  index_a )

inlineoverrideprotected

Index assignment.

template<typename O, typename S = Key, typename C = NoClient>

bool utility::keys::AutoKey< O, S, C >::less_than ( Key const &  key ) const

inlineoverrideprotected

Less than a Key?

template<typename O, typename S = Key, typename C = NoClient>

static Size utility::keys::AutoKey< O, S, C >::n_key ( )

inlinestatic

Number of keys with distinct indexes.

template<typename O, typename S = Key, typename C = NoClient>

static Size& utility::keys::AutoKey< O, S, C >::n_key_ ( )

inlinestaticprivate

Number of keys with distinct indexes.

Referenced by utility::keys::AutoKey< Option >::n_key(), and utility::keys::AutoKey< Option >::next_index().

template<typename O, typename S = Key, typename C = NoClient>

static Size utility::keys::AutoKey< O, S, C >::next_index ( )

inlinestaticprivate

Increment the index counter and return it.

template<typename O, typename S = Key, typename C = NoClient>

utility::keys::AutoKey< O, S, C >::operator Index ( ) const

inlineprotected

Index value conversion.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::operator= ( AutoKey< O, S, C > const &  key )

inline

Copy assignment.

template<typename O, typename S = Key, typename C = NoClient>

AutoKey& utility::keys::AutoKey< O, S, C >::operator= ( Key const &  key )

inline

Key assignment.

template<typename O, typename S = Key, typename C = NoClient>

Index utility::keys::AutoKey< O, S, C >::private_index ( ) const

inlineoverride

Index.

Note

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

Friends And Related Function Documentation

template<typename O, typename S = Key, typename C = NoClient>

bool operator!= ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey != AutoKey.

Note

Index-based equality

template<typename O, typename S = Key, typename C = NoClient>

bool operator< ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey < AutoKey.

Note

Index-based ordering

Needed for use as key in associative containers

template<typename O, typename S = Key, typename C = NoClient>

bool operator<= ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey <= AutoKey.

Note

Index-based ordering

template<typename O, typename S = Key, typename C = NoClient>

bool operator== ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey == AutoKey.

Note

Index-based equality

template<typename O, typename S = Key, typename C = NoClient>

bool operator> ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey > AutoKey.

Note

Index-based ordering

template<typename O, typename S = Key, typename C = NoClient>

bool operator>= ( AutoKey< O, S, C > const &  a, AutoKey< O, S, C > const &  b  )

friend

AutoKey >= AutoKey.

Note

Index-based ordering

template<typename O, typename S = Key, typename C = NoClient>

template<typename UO , typename US , typename UC >

bool sequential ( AutoKey< UO, US, UC > const &  a, AutoKey< UO, US, UC > const &  b  )

friend

AutoKeys are sequential?

Note

Index-based ordering

Member Data Documentation

template<typename O, typename S = Key, typename C = NoClient>

std::string utility::keys::AutoKey< O, S, C >::code_

private

Code: Coded identifier.

Referenced by utility::keys::AutoKey< Option >::assign_Key(), and utility::keys::AutoKey< Option >::code().

template<typename O, typename S = Key, typename C = NoClient>

std::string utility::keys::AutoKey< O, S, C >::id_

private

ID: Short identifier.

Referenced by utility::keys::AutoKey< Option >::assign_Key(), and utility::keys::AutoKey< Option >::id().

template<typename O, typename S = Key, typename C = NoClient>

std::string utility::keys::AutoKey< O, S, C >::identifier_

private

Identifier: Long identifier.

Referenced by utility::keys::AutoKey< Option >::assign_Key(), and utility::keys::AutoKey< Option >::identifier().

template<typename O, typename S = Key, typename C = NoClient>

Index utility::keys::AutoKey< O, S, C >::index_

private

Index.

Referenced by utility::keys::AutoKey< Option >::assign_Key(), utility::keys::AutoKey< Option >::equals(), utility::keys::AutoKey< Option >::index(), utility::keys::AutoKey< Option >::less_than(), utility::keys::AutoKey< Option >::operator Index(), and utility::keys::AutoKey< Option >::private_index().

---

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

• src/utility/keys/AutoKey.fwd.hh
• src/utility/keys/AutoKey.hh