Rosetta 3.3
Public Types | Public Member Functions | Protected Member Functions | Friends
utility::keys::UserKey< O, S, C > Class Template Reference

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

#include <UserKey.hh>

Inheritance diagram for utility::keys::UserKey< O, S, C >:
Inheritance graph
[legend]
Collaboration diagram for utility::keys::UserKey< O, S, C >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef utility::keys::Key Key
typedefobject_type
typedef std::size_t index_type
typedef std::size_t size_type
typedefObject
typedef std::size_t Index
typedef std::size_t Size

Public Member Functions

virtual UserKeyclone () const =0
 Clone this.
virtual ~UserKey ()
 Destructor.
UserKeyoperator= (UserKey const &key)
 Copy assignment.
UserKeyoperator= (Key const &key)
 Key assignment.
std::string const & id () const
 ID.
std::string & id ()
 ID.
UserKeyid (std::string const &id_a)
 ID assignment.
std::string const & identifier () const
 Identifier.
std::string & identifier ()
 Identifier.
UserKeyidentifier (std::string const &identifier_a)
 Identifier assignment.
std::string const & code () const
 Code.
std::string & code ()
 Code.
UserKeycode (std::string const &code_a)
 Code assignment.
Index private_index () const
 Index.

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.
 UserKey (UserKey const &key)
 Copy constructor.
 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.
 UserKey (Key const &key)
 Key constructor.
 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.
 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.
void assign_Key (Key const &key)
 Key assignment.
 operator Index () const
 Index value conversion.
Index index () const
 Index.
Indexindex ()
 Index.
UserKeyindex (Index const index_a)
 Index assignment.
bool equals (Key const &key) const
 Equal to a Key?
bool less_than (Key const &key) const
 Less than a Key?
bool comparable (Key const &key) const
 Comparable to a Key?

Friends

bool operator== (UserKey const &a, UserKey const &b)
 UserKey == UserKey.
bool operator!= (UserKey const &a, UserKey const &b)
 UserKey != UserKey.
bool operator< (UserKey const &a, UserKey const &b)
 UserKey < UserKey.
bool operator<= (UserKey const &a, UserKey const &b)
 UserKey <= UserKey.
bool operator>= (UserKey const &a, UserKey const &b)
 UserKey >= UserKey.
bool operator> (UserKey const &a, UserKey const &b)
 UserKey > UserKey.
bool sequential (UserKey const &a, UserKey const &b)
 UserKeys are sequential?

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

template<typename O , typename S , typename C >
typedef std::size_t utility::keys::UserKey< O, S, C >::Index
template<typename O , typename S , typename C >
typedef std::size_t utility::keys::UserKey< O, S, C >::index_type
template<typename O , typename S , typename C >
typedef utility::keys::Key utility::keys::UserKey< O, S, C >::Key
template<typename O , typename S , typename C >
typedef O utility::keys::UserKey< O, S, C >::Object
template<typename O , typename S , typename C >
typedef O utility::keys::UserKey< O, S, C >::object_type
template<typename O , typename S , typename C >
typedef std::size_t utility::keys::UserKey< O, S, C >::Size
template<typename O , typename S , typename C >
typedef std::size_t utility::keys::UserKey< O, S, C >::size_type

Constructor & Destructor Documentation

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() 
) [inline, explicit, protected]

Default constructor.

template<typename O , typename S , typename C >
utility::keys::UserKey< O, S, C >::UserKey ( UserKey< O, S, C > const &  key) [inline, protected]

Copy constructor.

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() 
) [inline, protected]

Copy + identifier constructor.

template<typename O , typename S , typename C >
utility::keys::UserKey< O, S, C >::UserKey ( Key const &  key) [inline, explicit, protected]

Key constructor.

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() 
) [inline, protected]

Key + identifier constructor.

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() 
) [inline, explicit, protected]

Index constructor.

template<typename O , typename S , typename C >
virtual utility::keys::UserKey< O, S, C >::~UserKey ( ) [inline, virtual]

Destructor.


Member Function Documentation

template<typename O , typename S , typename C >
void utility::keys::UserKey< O, S, C >::assign_Key ( Key const &  key) [inline, protected]
template<typename O , typename S , typename C >
virtual UserKey* utility::keys::UserKey< O, S, C >::clone ( ) const [pure virtual]

Clone this.

template<typename O , typename S , typename C >
std::string const& utility::keys::UserKey< O, S, C >::code ( ) const [inline]

Code.

template<typename O , typename S , typename C >
std::string& utility::keys::UserKey< O, S, C >::code ( ) [inline]

Code.

template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::code ( std::string const &  code_a) [inline]

Code assignment.

template<typename O , typename S , typename C >
bool utility::keys::UserKey< O, S, C >::comparable ( Key const &  key) const [inline, protected]

Comparable to a Key?

References key.

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

template<typename O , typename S , typename C >
bool utility::keys::UserKey< O, S, C >::equals ( Key const &  key) const [inline, protected]

Equal to a Key?

template<typename O , typename S , typename C >
std::string const& utility::keys::UserKey< O, S, C >::id ( ) const [inline]

ID.

template<typename O , typename S , typename C >
std::string& utility::keys::UserKey< O, S, C >::id ( ) [inline]

ID.

template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::id ( std::string const &  id_a) [inline]

ID assignment.

template<typename O , typename S , typename C >
std::string const& utility::keys::UserKey< O, S, C >::identifier ( ) const [inline]

Identifier.

template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::identifier ( std::string const &  identifier_a) [inline]

Identifier assignment.

template<typename O , typename S , typename C >
std::string& utility::keys::UserKey< O, S, C >::identifier ( ) [inline]

Identifier.

template<typename O , typename S , typename C >
Index utility::keys::UserKey< O, S, C >::index ( ) const [inline, protected]

Index.

template<typename O , typename S , typename C >
Index& utility::keys::UserKey< O, S, C >::index ( ) [inline, protected]

Index.

template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::index ( Index const  index_a) [inline, protected]

Index assignment.

template<typename O , typename S , typename C >
bool utility::keys::UserKey< O, S, C >::less_than ( Key const &  key) const [inline, protected]

Less than a Key?

template<typename O , typename S , typename C >
utility::keys::UserKey< O, S, C >::operator Index ( ) const [inline, protected]

Index value conversion.

template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::operator= ( Key const &  key) [inline]
template<typename O , typename S , typename C >
UserKey& utility::keys::UserKey< O, S, C >::operator= ( UserKey< O, S, C > const &  key) [inline]
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!

Friends And Related Function Documentation

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
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
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
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
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
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
template<typename O , typename S , typename C >
bool sequential ( UserKey< O, S, C > const &  a,
UserKey< O, S, C > const &  b 
) [friend]

UserKeys are sequential?

Note:
Index-based ordering

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines