image::modification_queue Class Reference

A modified priority queue used to order image modifications. More...

#include <image_modifications.hpp>

Public Member Functions
	modification_queue ()
	~modification_queue ()
bool	empty () const
void	push (modification *mod)
	Adds mod to the queue (unless mod is nullptr). More...
void	pop ()
	Removes the top element from the queue. More...
size_t	size () const
	Returns the number of elements in the queue. More...
modification *	top () const
	Returns the top element in the queue . More...

Private Types
typedef std::map< int, std::vector< modification * > , std::greater< int > >	map_type
	Map from a mod's priority() to the mods having that priority. More...

Private Attributes
map_type	priorities_
	Map from a mod's priority() to the mods having that priority. More...

Detailed Description

A modified priority queue used to order image modifications.

The priorities for this queue are to order modifications by priority(), then by the order they are added to the queue.

Definition at line 32 of file image_modifications.hpp.

Member Typedef Documentation

typedef std::map<int, std::vector<modification *>, std::greater<int> > image::modification_queue::map_type

private

Map from a mod's priority() to the mods having that priority.

Definition at line 52 of file image_modifications.hpp.

Constructor & Destructor Documentation

image::modification_queue::modification_queue ( )

inline

Definition at line 37 of file image_modifications.hpp.

image::modification_queue::~modification_queue ( )

inline

Definition at line 42 of file image_modifications.hpp.

Member Function Documentation

bool image::modification_queue::empty ( ) const

inline

Definition at line 44 of file image_modifications.hpp.

References priorities_.

Referenced by image::load_image_sub_file().

void image::modification_queue::pop

(

)

Removes the top element from the queue.

Definition at line 45 of file image_modifications.cpp.

References priorities_.

Referenced by BOOST_AUTO_TEST_CASE(), and image::load_image_sub_file().

void image::modification_queue::push

(

modification *

mod

)

Adds mod to the queue (unless mod is nullptr).

Definition at line 37 of file image_modifications.cpp.

References priorities_, and image::modification::priority().

Referenced by BOOST_AUTO_TEST_CASE(), and image::modification::decode().

size_t image::modification_queue::size

(

)

const

Returns the number of elements in the queue.

Definition at line 58 of file image_modifications.cpp.

References priorities_.

Referenced by BOOST_AUTO_TEST_CASE().

modification * image::modification_queue::top

(

)

const

Returns the top element in the queue .

Definition at line 67 of file image_modifications.cpp.

References priorities_.

Referenced by BOOST_AUTO_TEST_CASE(), and image::load_image_sub_file().

Member Data Documentation

map_type image::modification_queue::priorities_

private

Map from a mod's priority() to the mods having that priority.

Definition at line 54 of file image_modifications.hpp.

Referenced by empty(), pop(), push(), size(), and top().

---

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

• image_modifications.hpp
• image_modifications.cpp