Automatic hidden index key for any scalar-valued options. More...

#include <AnyOptionKey.hh>

Inheritance diagram for utility::options::AnyOptionKey:

[legend]

Public Member Functions
	AnyOptionKey ()
	Default constructor. More...

	AnyOptionKey (AnyOptionKey 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...

	AnyOptionKey (Key const &key)
	Key constructor. More...

	AnyOptionKey (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...

	AnyOptionKey (std::string const &id_a, std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
	Identifier constructor. More...

AnyOptionKey *	clone () const override
	Clone this. More...

	~AnyOptionKey () override
	Destructor. More...

AnyOptionKey &	operator= (Key const &key)
	Key assignment. More...

Public Member Functions inherited from utility::options::ScalarOptionKey
	~ScalarOptionKey () override
	Destructor. More...

ScalarOptionKey &	operator= (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...

OptionKey &	operator= (Key const &key)
	Key assignment. More...

Public Member Functions inherited from utility::keys::AutoKey< Option >
	~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...

Private Types
typedef ScalarOptionKey	Super

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

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

Public Types inherited from S
typedef struct S::_D	D

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

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

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

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

Detailed Description

Automatic hidden index key for any scalar-valued options.

Member Typedef Documentation

◆ Super

typedef ScalarOptionKey utility::options::AnyOptionKey::Super

private

Constructor & Destructor Documentation

◆ AnyOptionKey() [1/5]

utility::options::AnyOptionKey::AnyOptionKey ( )

inline

Default constructor.

Referenced by clone().

◆ AnyOptionKey() [2/5]

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

◆ AnyOptionKey() [3/5]

utility::options::AnyOptionKey::AnyOptionKey ( Key const & key )

inlineexplicit

Key constructor.

◆ AnyOptionKey() [4/5]

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

◆ AnyOptionKey() [5/5]

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

◆ ~AnyOptionKey()

utility::options::AnyOptionKey::~AnyOptionKey ( )

inlineoverride

Destructor.

Member Function Documentation

◆ clone()

AnyOptionKey* utility::options::AnyOptionKey::clone ( ) const

inlineoverridevirtual

Clone this.

Implements utility::options::ScalarOptionKey.

References AnyOptionKey().

◆ operator=()

AnyOptionKey& utility::options::AnyOptionKey::operator= ( Key const & key )

inline

Key assignment.

References utility::keys::AutoKey< Option >::assign_Key(), and subloop_histogram::key.

Friends And Related Function Documentation

◆ utility::keys::SmallKeyVector

template<typename K , typename T >

friend class utility::keys::SmallKeyVector

friend

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

src/utility/options/keys/AnyOptionKey.hh

Public Member Functions

Private Types

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ AnyOptionKey() [1/5]

◆ AnyOptionKey() [2/5]

◆ AnyOptionKey() [3/5]

◆ AnyOptionKey() [4/5]

◆ AnyOptionKey() [5/5]

◆ ~AnyOptionKey()

Member Function Documentation

◆ clone()

◆ operator=()

Friends And Related Function Documentation

◆ utility::keys::SmallKeyVector