User-created hidden index key abstract base class. More...

#include <UserKey.hh>

Inheritance diagram for utility::keys::UserKey< 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
virtual UserKey *	clone () const =0
	Clone this. More...

virtual	~UserKey ()
	Destructor. More...

UserKey &	operator= (UserKey const &key)
	Copy assignment. More...

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

std::string const &	id () const
	ID. More...

std::string &	id ()
	ID. More...

UserKey &	id (std::string const &id_a)
	ID assignment. More...

std::string const &	identifier () const
	Identifier. More...

std::string &	identifier ()
	Identifier. More...

UserKey &	identifier (std::string const &identifier_a)
	Identifier assignment. More...

std::string const &	code () const
	Code. More...

std::string &	code ()
	Code. More...

UserKey &	code (std::string const &code_a)
	Code assignment. More...

Index	private_index () const
	Index. More...

Protected Member Functions
	UserKey (std::string const &id_a=std::string(), std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
	Default constructor. More...

	UserKey (UserKey const &key)
	Copy constructor. More...

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

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

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

	UserKey (Index const index_a, std::string const &id_a=std::string(), std::string const &identifier_a=std::string(), std::string const &code_a=std::string())
	Index constructor. More...

void	assign_Key (Key const &key)
	Key assignment. More...

	operator Index () const
	Index value conversion. More...

Index	index () const
	Index. More...

Index &	index ()
	Index. More...

UserKey &	index (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 S	Super

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== (UserKey const &a, UserKey const &b)
	UserKey == UserKey. More...

bool	operator!= (UserKey const &a, UserKey const &b)
	UserKey != UserKey. More...

bool	operator< (UserKey const &a, UserKey const &b)
	UserKey < UserKey. More...

bool	operator<= (UserKey const &a, UserKey const &b)
	UserKey <= UserKey. More...

bool	operator>= (UserKey const &a, UserKey const &b)
	UserKey >= UserKey. More...

bool	operator> (UserKey const &a, UserKey const &b)
	UserKey > UserKey. More...

template<typename UO , typename US , typename UC >
bool	sequential (UserKey< UO, US, UC > const &a, UserKey< UO, US, UC > const &b)
	UserKeys 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, typename C>
class utility::keys::UserKey< O, S, C >

User-created hidden index key abstract base class.

Member Typedef Documentation

◆ Index

template<typename O , typename S , typename C >

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

◆ index_type

template<typename O , typename S , typename C >

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

◆ Key

template<typename O , typename S , typename C >

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

◆ Object

template<typename O , typename S , typename C >

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

◆ object_type

template<typename O , typename S , typename C >

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

◆ Size

template<typename O , typename S , typename C >

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

◆ size_type

template<typename O , typename S , typename C >

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

◆ Super

template<typename O , typename S , typename C >

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

private

Constructor & Destructor Documentation

◆ UserKey() [1/6]

template<typename O , typename S , typename C >

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

inlineexplicitprotected

Default constructor.

◆ UserKey() [2/6]

template<typename O , typename S , typename C >

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

inlineprotected

Copy constructor.

◆ UserKey() [3/6]

template<typename O , typename S , typename C >

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

◆ UserKey() [4/6]

template<typename O , typename S , typename C >

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

inlineexplicitprotected

Key constructor.

References debug_assert, and subloop_histogram::key.

◆ UserKey() [5/6]

template<typename O , typename S , typename C >

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

References debug_assert, and subloop_histogram::key.

◆ UserKey() [6/6]

template<typename O , typename S , typename C >

utility::keys::UserKey< O, S, C >::UserKey	(	Index const	index_a,
		std::string const &	id_a = `std::string()`,
		std::string const &	identifier_a = `std::string()`,
		std::string const &	code_a = `std::string()`
	)

inlineexplicitprotected

Index constructor.

◆ ~UserKey()

template<typename O , typename S , typename C >

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

inlinevirtual

Destructor.

Member Function Documentation

◆ assign_Key()

template<typename O , typename S , typename C >

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

inlineprotected

Key assignment.

References utility::keys::UserKey< O, S, C >::code_, utility::keys::UserKey< O, S, C >::comparable(), debug_assert, utility::keys::UserKey< O, S, C >::id_, utility::keys::UserKey< O, S, C >::identifier_, utility::keys::UserKey< O, S, C >::index_, and subloop_histogram::key.

Referenced by utility::keys::UserKey< O, S, C >::operator=().

◆ clone()

template<typename O , typename S , typename C >

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

pure virtual

Clone this.

◆ code() [1/3]

template<typename O , typename S , typename C >

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

inline

Code.

References utility::keys::UserKey< O, S, C >::code_.

◆ code() [2/3]

template<typename O , typename S , typename C >

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

inline

Code.

References utility::keys::UserKey< O, S, C >::code_.

◆ code() [3/3]

template<typename O , typename S , typename C >

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

inline

Code assignment.

References utility::keys::UserKey< O, S, C >::code_.

◆ comparable()

template<typename O , typename S , typename C >

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

inlineprotected

Comparable to a Key?

References subloop_histogram::key.

Referenced by utility::keys::UserKey< O, S, C >::assign_Key().

◆ equals()

template<typename O , typename S , typename C >

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

inlineprotected

Equal to a Key?

References utility::keys::UserKey< O, S, C >::index_, and subloop_histogram::key.

◆ id() [1/3]

template<typename O , typename S , typename C >

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

inline

ID.

References utility::keys::UserKey< O, S, C >::id_.

Referenced by schema.Job::__repr__().

◆ id() [2/3]

template<typename O , typename S , typename C >

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

inline

ID.

References utility::keys::UserKey< O, S, C >::id_.

Referenced by schema.Job::__repr__().

◆ id() [3/3]

template<typename O , typename S , typename C >

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

inline

ID assignment.

References utility::keys::UserKey< O, S, C >::id_.

Referenced by schema.Job::__repr__().

◆ identifier() [1/3]

template<typename O , typename S , typename C >

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

inline

Identifier.

References utility::keys::UserKey< O, S, C >::identifier_.

◆ identifier() [2/3]

template<typename O , typename S , typename C >

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

inline

Identifier.

References utility::keys::UserKey< O, S, C >::identifier_.

◆ identifier() [3/3]

template<typename O , typename S , typename C >

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

inline

Identifier assignment.

References utility::keys::UserKey< O, S, C >::identifier_.

◆ index() [1/3]

template<typename O , typename S , typename C >

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

inlineprotected

Index.

References utility::keys::UserKey< O, S, C >::index_.

◆ index() [2/3]

template<typename O , typename S , typename C >

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

inlineprotected

Index.

References utility::keys::UserKey< O, S, C >::index_.

◆ index() [3/3]

template<typename O , typename S , typename C >

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

inlineprotected

Index assignment.

References utility::keys::UserKey< O, S, C >::index_.

◆ less_than()

template<typename O , typename S , typename C >

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

inlineprotected

Less than a Key?

References utility::keys::UserKey< O, S, C >::index_, and subloop_histogram::key.

◆ operator Index()

template<typename O , typename S , typename C >

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

inlineprotected

Index value conversion.

References utility::keys::UserKey< O, S, C >::index_.

◆ operator=() [1/2]

template<typename O , typename S , typename C >

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

inline

Key assignment.

References utility::keys::UserKey< O, S, C >::assign_Key(), and subloop_histogram::key.

◆ operator=() [2/2]

template<typename O , typename S , typename C >

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

inline

Copy assignment.

References utility::keys::UserKey< O, S, C >::assign_Key(), and subloop_histogram::key.

◆ private_index()

template<typename O , typename S , typename C >

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

inline

Index.

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

References utility::keys::UserKey< O, S, C >::index_.

Friends And Related Function Documentation

◆ operator!=

template<typename O , typename S , typename C >

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

friend

UserKey != UserKey.

Note: Index-based equality

◆ operator<

template<typename O , typename S , typename C >

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

friend

UserKey < UserKey.

Note: Index-based ordering; Needed for use as key in associative containers

◆ operator<=

template<typename O , typename S , typename C >

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

friend

UserKey <= UserKey.

Note: Index-based ordering

◆ operator==

template<typename O , typename S , typename C >

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

friend

UserKey == UserKey.

Note: Index-based equality

◆ operator>

template<typename O , typename S , typename C >

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

friend

UserKey > UserKey.

Note: Index-based ordering

◆ operator>=

template<typename O , typename S , typename C >

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

friend

UserKey >= UserKey.

Note: Index-based ordering

◆ sequential

template<typename O , typename S , typename C >

template<typename UO , typename US , typename UC >

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

friend

UserKeys are sequential?

Note: Index-based ordering

Member Data Documentation

◆ code_

template<typename O , typename S , typename C >

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

private

Code: Coded identifier.

Referenced by utility::keys::UserKey< O, S, C >::assign_Key(), and utility::keys::UserKey< O, S, C >::code().

◆ id_

template<typename O , typename S , typename C >

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

private

ID: Short identifier.

Referenced by utility::keys::UserKey< O, S, C >::assign_Key(), and utility::keys::UserKey< O, S, C >::id().

◆ identifier_

template<typename O , typename S , typename C >

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

private

Identifier: Long identifier.

Referenced by utility::keys::UserKey< O, S, C >::assign_Key(), and utility::keys::UserKey< O, S, C >::identifier().

◆ index_

template<typename O , typename S , typename C >

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

private

Index.

Referenced by utility::keys::UserKey< O, S, C >::assign_Key(), utility::keys::UserKey< O, S, C >::equals(), utility::keys::UserKey< O, S, C >::index(), utility::keys::UserKey< O, S, C >::less_than(), utility::keys::UserKey< O, S, C >::operator Index(), and utility::keys::UserKey< O, S, C >::private_index().

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

src/utility/keys/UserKey.fwd.hh
src/utility/keys/UserKey.hh

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename O, typename S, typename C> class utility::keys::UserKey< O, S, C >

Member Typedef Documentation

◆ Index

◆ index_type

◆ Key

◆ Object

◆ object_type

◆ Size

◆ size_type

◆ Super

Constructor & Destructor Documentation

◆ UserKey() [1/6]

◆ UserKey() [2/6]

◆ UserKey() [3/6]

◆ UserKey() [4/6]

◆ UserKey() [5/6]

◆ UserKey() [6/6]

◆ ~UserKey()

Member Function Documentation

◆ assign_Key()

◆ clone()

◆ code() [1/3]

◆ code() [2/3]

◆ code() [3/3]

◆ comparable()

◆ equals()

◆ id() [1/3]

◆ id() [2/3]

◆ id() [3/3]

◆ identifier() [1/3]

◆ identifier() [2/3]

◆ identifier() [3/3]

◆ index() [1/3]

◆ index() [2/3]

◆ index() [3/3]

◆ less_than()

◆ operator Index()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ private_index()

Friends And Related Function Documentation

◆ operator!=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

◆ sequential

Member Data Documentation

◆ code_

◆ id_

◆ identifier_

◆ index_

template<typename O, typename S, typename C>
class utility::keys::UserKey< O, S, C >