FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Core::FMTLookup< inmemory, pointer > Class Template Reference

Lookup helper holding an in-memory object and a pointer to a keyed object, used for hashing and comparison. More...

#include <FMTLookup.h>

Public Member Functions

 FMTLookup ()=default
 Default constructor for FMTLookup.
 
 ~FMTLookup ()=default
 Default destructor for FMTLookup.
 
 FMTLookup (const pointer &ptr)
 Construct a lookup for searching from a pointer.
 
 FMTLookup (const inmemory &des, const pointer &dev)
 Construct a lookup for keeping from an in-memory object and a pointer.
 
 FMTLookup (const FMTLookup &rhs)
 Copy constructor for FMTLookup.
 
FMTLookupoperator= (const FMTLookup &rhs)
 Copy assignment operator for FMTLookup.
 
bool operator< (const FMTLookup &rhs) const
 Less than comparison operator of FMTLookup.
 
bool operator== (const FMTLookup &rhs) const
 Equality comparison operator of FMTLookup.
 

Public Attributes

inmemory memoryobject
 
const pointer * pointerobject
 

Detailed Description

template<class inmemory, class pointer>
class Core::FMTLookup< inmemory, pointer >

Lookup helper holding an in-memory object and a pointer to a keyed object, used for hashing and comparison.

Template Parameters
inmemorythe in-memory object type.
pointerthe pointed object type.

Constructor & Destructor Documentation

◆ FMTLookup() [1/4]

template<class inmemory , class pointer >
Core::FMTLookup< inmemory, pointer >::FMTLookup ( )
default

Default constructor for FMTLookup.

◆ ~FMTLookup()

template<class inmemory , class pointer >
Core::FMTLookup< inmemory, pointer >::~FMTLookup ( )
default

Default destructor for FMTLookup.

◆ FMTLookup() [2/4]

template<class inmemory , class pointer >
Core::FMTLookup< inmemory, pointer >::FMTLookup ( const pointer &  ptr)
inline

Construct a lookup for searching from a pointer.

Parameters
[in]ptrthe pointed object.

◆ FMTLookup() [3/4]

template<class inmemory , class pointer >
Core::FMTLookup< inmemory, pointer >::FMTLookup ( const inmemory &  des,
const pointer &  dev 
)
inline

Construct a lookup for keeping from an in-memory object and a pointer.

Parameters
[in]desthe in-memory object.
[in]devthe pointed object.

◆ FMTLookup() [4/4]

template<class inmemory , class pointer >
Core::FMTLookup< inmemory, pointer >::FMTLookup ( const FMTLookup< inmemory, pointer > &  rhs)
inline

Copy constructor for FMTLookup.

Parameters
[in]rhsthe FMTLookup to copy.

Member Function Documentation

◆ operator<()

template<class inmemory , class pointer >
bool Core::FMTLookup< inmemory, pointer >::operator< ( const FMTLookup< inmemory, pointer > &  rhs) const
inline

Less than comparison operator of FMTLookup.

Parameters
[in]rhsthe lookup to compare with.
Returns
true if this lookup is less than rhs else false.

◆ operator=()

template<class inmemory , class pointer >
FMTLookup & Core::FMTLookup< inmemory, pointer >::operator= ( const FMTLookup< inmemory, pointer > &  rhs)
inline

Copy assignment operator for FMTLookup.

Parameters
[in]rhsthe FMTLookup to copy.
Returns
a reference to this FMTLookup.

◆ operator==()

template<class inmemory , class pointer >
bool Core::FMTLookup< inmemory, pointer >::operator== ( const FMTLookup< inmemory, pointer > &  rhs) const
inline

Equality comparison operator of FMTLookup.

Parameters
[in]rhsthe lookup to compare with.
Returns
true if both lookups are equal else false.

Member Data Documentation

◆ memoryobject

template<class inmemory , class pointer >
inmemory Core::FMTLookup< inmemory, pointer >::memoryobject

◆ pointerobject

template<class inmemory , class pointer >
const pointer* Core::FMTLookup< inmemory, pointer >::pointerobject

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