Sierra Toolkit  Version of the Day
sierra::MapvNode< Key_Type, Key_Compare > Class Template Reference

#include <Mapv.hpp>

Inherits sierra::MapvNodeBase.

Public Types

typedef Key_Type key_type
 
typedef Key_Compare key_compare
 

Public Member Functions

bool mapv_valid () const
 
void mapv_remove ()
 
const key_type & mapv_key () const
 
const Key_Type & mapv_key (const key_type &K)
 
virtual ~MapvNode ()
 
 MapvNode (const key_type &K)
 

Friends

template<class dType , class N , class P >
class MapvIterator
 
template<class dType , class mPolicy >
class Mapv
 

Detailed Description

template<typename Key_Type, class Key_Compare = std::less<Key_Type>>
class sierra::MapvNode< Key_Type, Key_Compare >

Base class for Mapv nodes. Objects stored in a Mapv container are derived from this template base class as follows.

class Derived_Type : [ other classes , ] public MapvNode<Key_Type> [ , other classes ] { ... };

OR class Derived_Type : [ other classes , ] public MapvNode<Key_Type,Key_Less> [ , other classes ] { ... };

Definition at line 112 of file Mapv.hpp.

Constructor & Destructor Documentation

◆ ~MapvNode()

template<typename Key_Type, class Key_Compare = std::less<Key_Type>>
virtual sierra::MapvNode< Key_Type, Key_Compare >::~MapvNode ( )
inlinevirtual

A destroyed node is automatically removed from its container

Definition at line 185 of file Mapv.hpp.

Member Function Documentation

◆ mapv_key() [1/2]

template<typename Key_Type, class Key_Compare = std::less<Key_Type>>
const key_type& sierra::MapvNode< Key_Type, Key_Compare >::mapv_key ( ) const
inline

Query key

Definition at line 178 of file Mapv.hpp.

◆ mapv_key() [2/2]

template<typename Key_Type, class Key_Compare = std::less<Key_Type>>
const Key_Type& sierra::MapvNode< Key_Type, Key_Compare >::mapv_key ( const key_type &  K)
inline

Set key, => forces removal of the node from its 'Mapv' container

Definition at line 181 of file Mapv.hpp.


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