Spinning Topp Logo BlackTopp Studios
inc
Public Types | Public Member Functions | Protected Attributes | List of all members
Mezzanine::Input::MetaCodeKey Class Reference

A key class for MetaCodes to be used in associative containers. More...

#include <metacodekey.h>

+ Collaboration diagram for Mezzanine::Input::MetaCodeKey:

Public Types

typedef BooleDeviceCompare) (const MetaCode &First, const MetaCode &Second)
 Convenience typedef for the compare method to be used by this key.
 

Public Member Functions

 MetaCodeKey (const MetaCode &Code)
 Class constructor. More...
 
 MetaCodeKey (const MetaCodeKey &Other)
 Copy constructor. More...
 
 ~MetaCodeKey ()
 Class destructor.
 
const MetaCodeGetKeyData () const
 Gets the MetaCode this object is using for sorting. More...
 
Boole operator< (const MetaCodeKey &Other) const
 Less-than operator. More...
 

Protected Attributes

DeviceCompareCompare
 The compare method being used for this key. More...
 
const MetaCode MCode
 The metacode being used as the compare object. More...
 

Detailed Description

A key class for MetaCodes to be used in associative containers.

Definition at line 56 of file metacodekey.h.

Constructor & Destructor Documentation

Mezzanine::Input::MetaCodeKey::MetaCodeKey ( const MetaCode Code)

Class constructor.

Parameters
CodeThe MetaCode this key is to use for sorting.

Definition at line 109 of file metacodekey.cpp.

Mezzanine::Input::MetaCodeKey::MetaCodeKey ( const MetaCodeKey Other)

Copy constructor.

Parameters
OtherThe other MetaCodeKey to copy.

Definition at line 126 of file metacodekey.cpp.

Member Function Documentation

const MetaCode & Mezzanine::Input::MetaCodeKey::GetKeyData ( ) const

Gets the MetaCode this object is using for sorting.

Returns
Returns a const reference to the MetaCode stored by this object.

Definition at line 137 of file metacodekey.cpp.

Boole Mezzanine::Input::MetaCodeKey::operator< ( const MetaCodeKey Other) const

Less-than operator.

Parameters
OtherThe other key to compare against.
Returns
Returns true if this key is less than another key.

Definition at line 140 of file metacodekey.cpp.

Member Data Documentation

DeviceCompare* Mezzanine::Input::MetaCodeKey::Compare
protected

The compare method being used for this key.

Definition at line 67 of file metacodekey.h.

const MetaCode Mezzanine::Input::MetaCodeKey::MCode
protected

The metacode being used as the compare object.

Definition at line 64 of file metacodekey.h.


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