paludis::Generator Class Reference

#include <generator.hh>

Inheritance diagram for paludis::Generator:

Public Member Functions
	operator FilteredGenerator () const PALUDIS_ATTRIBUTE((warn_unused_result))
std::string	as_string () const PALUDIS_ATTRIBUTE((warn_unused_result))

Protected Member Functions
	Generator (const std::shared_ptr< const GeneratorHandler > &)

Basic operations
	Generator (const Generator &)
Generator &	operator= (const Generator &)
	~Generator ()

For use by Selection
std::shared_ptr< const RepositoryNameSet >	repositories (const Environment *const, const RepositoryContentMayExcludes &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const CategoryNamePartSet >	categories (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &, const RepositoryContentMayExcludes &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const QualifiedPackageNameSet >	packages (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &, const std::shared_ptr< const CategoryNamePartSet > &, const RepositoryContentMayExcludes &) const PALUDIS_ATTRIBUTE((warn_unused_result))
std::shared_ptr< const PackageIDSet >	ids (const Environment *const, const std::shared_ptr< const RepositoryNameSet > &, const std::shared_ptr< const QualifiedPackageNameSet > &, const RepositoryContentMayExcludes &) const PALUDIS_ATTRIBUTE((warn_unused_result))

Detailed Description

A Generator specifies general properties desired from the PackageID instances to be returned by Environment::operator[].

A Generator can be converted implicitly to a FilteredGenerator, either for being passed directly to a Selection subclass or for combining with one or more Filter subclasses.

Constructor & Destructor Documentation

paludis::Generator::Generator

(

const Generator &

)

Generator subclasses can be copied without losing information.

Member Function Documentation

std::string paludis::Generator::as_string

(

)

const

We are representable as a string, for use when stringifying.

std::shared_ptr<const CategoryNamePartSet> paludis::Generator::categories	(	const Environment *	const,
		const std::shared_ptr< const RepositoryNameSet > &	,
		const RepositoryContentMayExcludes &
	)		const

Used by Selection subclasses to get a candidate set of categories for consideration.

std::shared_ptr<const PackageIDSet> paludis::Generator::ids	(	const Environment *	const,
		const std::shared_ptr< const RepositoryNameSet > &	,
		const std::shared_ptr< const QualifiedPackageNameSet > &	,
		const RepositoryContentMayExcludes &
	)		const

Used by Selection subclasses to get a candidate set of PackageID instances for consideration.

paludis::Generator::operator FilteredGenerator

(

)

const

We can implicitly convert to a FilteredGenerator, for being passed to a Selection subclass or combined with one or more Filter subclasses.

std::shared_ptr<const QualifiedPackageNameSet> paludis::Generator::packages	(	const Environment *	const,
		const std::shared_ptr< const RepositoryNameSet > &	,
		const std::shared_ptr< const CategoryNamePartSet > &	,
		const RepositoryContentMayExcludes &
	)		const

Used by Selection subclasses to get a candidate set of package names for consideration.

std::shared_ptr<const RepositoryNameSet> paludis::Generator::repositories	(	const Environment *	const,
		const RepositoryContentMayExcludes &
	)		const

Used by Selection subclasses to get a candidate set of repositories for consideration.

---

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

• /home/users/ciaranm/work/paludis/paludis/generator.hh