Find the best candidates e.g. More...

#include <PoolItemBest.h>

Classes
struct	Impl
	PoolItemBest implementation. More...

Public Types
typedef boost::function< bool(const PoolItem &lhs, const PoolItem &rhs)>	Predicate
	Predicate returning `True` if lhs is a better choice. More...

typedef Container::size_type	size_type

typedef Container::value_type	value_type

typedef MapKVIteratorTraits < Container > ::Value_const_iterator	iterator

typedef MapKVIteratorTraits < Container > ::Key_const_iterator	ident_iterator

Public Member Functions
	PoolItemBest (bool preferNotLocked_r=false)
	Default ctor. More...

	PoolItemBest (sat::Solvable slv_r, bool preferNotLocked_r=false)
	Ctor feeding a sat::Solvable. More...

	PoolItemBest (const PoolItem &pi_r, bool preferNotLocked_r=false)
	Ctor feeding a PoolItem. More...

template<class TIterator >
	PoolItemBest (TIterator begin_r, TIterator end_r, bool preferNotLocked_r=false)
	Ctor feeding a range of sat::Solvable or PoolItem. More...

void	add (sat::Solvable slv_r)
	Feed one sat::Solvable. More...

void	add (const PoolItem &pi_r)
	Feed one PoolItem. More...

template<class TIterator >
void	add (TIterator begin_r, TIterator end_r)
	Feed a range of sat::Solvable or PoolItem. More...

Iterate the collected PoolItems.
bool	empty () const
	Whether PoolItems were collected. More...

size_type	size () const
	Number of PoolItems collected. More...

iterator	begin () const
	Pointer to the first PoolItem. More...

iterator	end () const
	Pointer behind the last PoolItem. More...

PoolItem	find (IdString ident_r) const
	Return the collected PoolItem with sat::Solvable::ident ident_r. More...

PoolItem	find (sat::Solvable slv_r) const

PoolItem	find (const PoolItem &pi_r) const

Iterate the collected PoolItems ident strings.
ident_iterator	identBegin () const
	Pointer to the first item. More...

ident_iterator	identEnd () const
	Pointer behind the last item. More...

Static Public Attributes
static constexpr bool	preferNotLocked = true
	Indicator argument for ctor: consider locked packages less than not locked packages. More...

Private Types
typedef std::unordered_map < IdString, PoolItem >	Container

Private Member Functions
void	_ctor_init (bool preferNotLocked_r)

void	_ctor_init ()
	bin.compat legacy More...

const Container &	container () const

RWCOW_pointer< Impl > &	pimpl ()
	Pointer to implementation. More...

const RWCOW_pointer< Impl > &	pimpl () const
	Pointer to implementation. More...

Private Attributes
shared_ptr< void >	_dont_use_this_use_pimpl
	Avoid need to include Impl definition when inlined ctors (due to tepmlate) are provided. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &str, const PoolItemBest &obj)

Detailed Description

Find the best candidates e.g.

in a PoolQuery result.

The class basically maintains a map<IdString,PoolItem> and remembers for each ident (sat::Solvable::ident) the best PoolItem that was added.

The default Predicate to determine the best choice is the same that sorts the ui::Selectable list of available objects, thus follows the same rules the resolver will apply.

Ctor argument preferNotLocked causes locked packages to be considered less than not locked packages.

 PoolQuery q;
 q.addAttribute(sat::SolvAttr::name, "lib*");
 q.setMatchGlob();
// get the best matches and tag them for installation:
PoolItemBest bestMatches( q.begin(), q.end() );
if ( ! bestMatches.empty() )
{
  for_( it, bestMatches.begin(), bestMatches.end() )
  {
    ui::asSelectable()( *it )->setOnSystem( *it, ResStatus::USER );
  }
}

Todo:: Support arbitrary Predicates.

Definition at line 63 of file PoolItemBest.h.

Member Typedef Documentation

typedef std::unordered_map<IdString,PoolItem> zypp::PoolItemBest::Container

private

Definition at line 65 of file PoolItemBest.h.

typedef boost::function<bool ( const PoolItem & lhs, const PoolItem & rhs )> zypp::PoolItemBest::Predicate

Predicate returning True if lhs is a better choice.

Definition at line 68 of file PoolItemBest.h.

typedef Container::size_type zypp::PoolItemBest::size_type

Definition at line 70 of file PoolItemBest.h.

typedef Container::value_type zypp::PoolItemBest::value_type

Definition at line 71 of file PoolItemBest.h.

typedef MapKVIteratorTraits<Container>::Value_const_iterator zypp::PoolItemBest::iterator

Definition at line 72 of file PoolItemBest.h.

typedef MapKVIteratorTraits<Container>::Key_const_iterator zypp::PoolItemBest::ident_iterator

Definition at line 73 of file PoolItemBest.h.

Constructor & Destructor Documentation

zypp::PoolItemBest::PoolItemBest ( bool preferNotLocked_r = false )

inline

Default ctor.

Definition at line 81 of file PoolItemBest.h.

zypp::PoolItemBest::PoolItemBest	(	sat::Solvable	slv_r,
		bool	preferNotLocked_r = `false`
	)

inline

Ctor feeding a sat::Solvable.

Definition at line 85 of file PoolItemBest.h.

zypp::PoolItemBest::PoolItemBest	(	const PoolItem &	pi_r,
		bool	preferNotLocked_r = `false`
	)

inline

Ctor feeding a PoolItem.

Definition at line 89 of file PoolItemBest.h.

template<class TIterator >

zypp::PoolItemBest::PoolItemBest	(	TIterator	begin_r,
		TIterator	end_r,
		bool	preferNotLocked_r = `false`
	)

inline

Ctor feeding a range of sat::Solvable or PoolItem.

Definition at line 94 of file PoolItemBest.h.

Member Function Documentation

void zypp::PoolItemBest::add ( sat::Solvable slv_r )

inline

Feed one sat::Solvable.

Definition at line 99 of file PoolItemBest.h.

void zypp::PoolItemBest::add ( const PoolItem & pi_r )

Feed one PoolItem.

Definition at line 61 of file PoolItemBest.cc.

template<class TIterator >

void zypp::PoolItemBest::add	(	TIterator	begin_r,
		TIterator	end_r
	)

inline

Feed a range of sat::Solvable or PoolItem.

Definition at line 107 of file PoolItemBest.h.

bool zypp::PoolItemBest::empty ( ) const

inline

Whether PoolItems were collected.

Definition at line 117 of file PoolItemBest.h.

size_type zypp::PoolItemBest::size ( ) const

inline

Number of PoolItems collected.

Definition at line 119 of file PoolItemBest.h.

iterator zypp::PoolItemBest::begin ( ) const

inline

Pointer to the first PoolItem.

Definition at line 121 of file PoolItemBest.h.

iterator zypp::PoolItemBest::end ( ) const

inline

Pointer behind the last PoolItem.

Definition at line 123 of file PoolItemBest.h.

PoolItem zypp::PoolItemBest::find ( IdString ident_r ) const

Return the collected PoolItem with sat::Solvable::ident ident_r.

Definition at line 85 of file PoolItemBest.cc.

PoolItem zypp::PoolItemBest::find ( sat::Solvable slv_r ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 128 of file PoolItemBest.h.

PoolItem zypp::PoolItemBest::find ( const PoolItem & pi_r ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 130 of file PoolItemBest.h.

ident_iterator zypp::PoolItemBest::identBegin ( ) const

inline

Pointer to the first item.

Definition at line 136 of file PoolItemBest.h.

ident_iterator zypp::PoolItemBest::identEnd ( ) const

inline

Pointer behind the last item.

Definition at line 138 of file PoolItemBest.h.

void zypp::PoolItemBest::_ctor_init ( bool preferNotLocked_r )

private

Definition at line 52 of file PoolItemBest.cc.

void zypp::PoolItemBest::_ctor_init ( )

private

bin.compat legacy

Definition at line 55 of file PoolItemBest.cc.

const PoolItemBest::Container & zypp::PoolItemBest::container ( ) const

private

Definition at line 58 of file PoolItemBest.cc.

RWCOW_pointer<Impl>& zypp::PoolItemBest::pimpl ( )

inlineprivate

Pointer to implementation.

Definition at line 149 of file PoolItemBest.h.

const RWCOW_pointer<Impl>& zypp::PoolItemBest::pimpl ( ) const

inlineprivate

Pointer to implementation.

Definition at line 151 of file PoolItemBest.h.

Friends And Related Function Documentation

std::ostream & operator<<	(	std::ostream &	str,
		const PoolItemBest &	obj
	)

Definition at line 97 of file PoolItemBest.cc.

Member Data Documentation

constexpr bool zypp::PoolItemBest::preferNotLocked = true

static

Indicator argument for ctor: consider locked packages less than not locked packages.

Definition at line 77 of file PoolItemBest.h.

shared_ptr<void> zypp::PoolItemBest::_dont_use_this_use_pimpl

private

Avoid need to include Impl definition when inlined ctors (due to tepmlate) are provided.

Definition at line 153 of file PoolItemBest.h.

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

zypp/PoolItemBest.h
zypp/PoolItemBest.cc

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Related Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation