Base class implementing common features of RepoInfo and ServiceInfo. More...

#include <repo/RepoInfoBase.h>

Inheritance diagram for zypp::repo::RepoInfoBase:

Classes
class	Impl
	RepoInfoBase data. More...

Public Member Functions
	RepoInfoBase ()

	RepoInfoBase (const std::string &alias)

virtual	~RepoInfoBase ()

std::string	alias () const
	unique identifier for this source.

std::string	escaped_alias () const
	Same as alias(), just escaped in a way to be a valid file name.

std::string	name () const
	Repository name.

std::string	rawName () const
	The raw metadata name (no default, no variables replaced).

std::string	label () const
	Label for use in messages for the user interface.

std::string	asUserString () const
	User string: label (alias or name)

bool	enabled () const
	If enabled is false, then this repository must be ignored as if does not exists, except when checking for duplicate alias.

bool	autorefresh () const
	If true, the repostory must be refreshed before creating resolvables from it.

Pathname	filepath () const
	File where this repo was read from.

void	setAlias (const std::string &alias)
	set the repository alias

void	setName (const std::string &name)
	set the repository name

void	setEnabled (bool enabled)
	enable or disable the repository

void	setAutorefresh (bool autorefresh)
	enable or disable autorefresh

void	setFilepath (const Pathname &filename)
	set the path to the .repo file

virtual std::ostream &	dumpOn (std::ostream &str) const
	Write a human-readable representation of this RepoInfoBase object into the str stream.

virtual std::ostream &	dumpAsIniOn (std::ostream &str) const
	Write this RepoInfoBase object into str in a .repo (ini) file format.

virtual std::ostream &	dumpAsXmlOn (std::ostream &str, const std::string &content="") const
	Write an XML representation of this object with content (if available).

Private Attributes
RWCOW_pointer< Impl >	_pimpl
	Pointer to implementation.

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

Related Functions
(Note that these are not member functions.)
typedef shared_ptr< RepoInfoBase >	RepoInfoBase_Ptr

typedef shared_ptr< const RepoInfoBase >	RepoInfoBase_constPtr

bool	operator== (const RepoInfoBase &lhs, const RepoInfoBase &rhs)

bool	operator!= (const RepoInfoBase &lhs, const RepoInfoBase &rhs)

std::ostream &	operator<< (std::ostream &str, const RepoInfoBase &obj)
	Stream output.

Detailed Description

Base class implementing common features of RepoInfo and ServiceInfo.

Note: Name is subject to repo variable replacement (

See also: RepoVariablesStringReplacer).

Definition at line 39 of file RepoInfoBase.h.

Constructor & Destructor Documentation

◆ RepoInfoBase() [1/2]

zypp::repo::RepoInfoBase::RepoInfoBase ( )

Definition at line 77 of file RepoInfoBase.cc.

◆ RepoInfoBase() [2/2]

zypp::repo::RepoInfoBase::RepoInfoBase ( const std::string & alias )

Definition at line 81 of file RepoInfoBase.cc.

◆ ~RepoInfoBase()

zypp::repo::RepoInfoBase::~RepoInfoBase ( )

virtual

Definition at line 85 of file RepoInfoBase.cc.

Member Function Documentation

◆ alias()

std::string zypp::repo::RepoInfoBase::alias ( ) const

unique identifier for this source.

If not specified It should be generated from the base url.

Normally, in a .repo file the section name is used ( [somerepo] )

Definition at line 111 of file RepoInfoBase.cc.

◆ escaped_alias()

std::string zypp::repo::RepoInfoBase::escaped_alias ( ) const

Same as alias(), just escaped in a way to be a valid file name.

Definition at line 114 of file RepoInfoBase.cc.

◆ name()

std::string zypp::repo::RepoInfoBase::name ( ) const

Repository name.

Short label or description of the repository. Defaults to alias. Subject to repo variable replacement (

See also: RepoVariablesStringReplacer). ie: "SUSE Linux 10.2 updates"

Definition at line 117 of file RepoInfoBase.cc.

◆ rawName()

std::string zypp::repo::RepoInfoBase::rawName ( ) const

The raw metadata name (no default, no variables replaced).

Definition at line 124 of file RepoInfoBase.cc.

◆ label()

std::string zypp::repo::RepoInfoBase::label ( ) const

Label for use in messages for the user interface.

Returns an alias or name, according to ZConfig::repoLabelIsAlias().

Definition at line 127 of file RepoInfoBase.cc.

◆ asUserString()

std::string zypp::repo::RepoInfoBase::asUserString ( ) const

inline

User string: label (alias or name)

Definition at line 82 of file RepoInfoBase.h.

◆ enabled()

bool zypp::repo::RepoInfoBase::enabled ( ) const

If enabled is false, then this repository must be ignored as if does not exists, except when checking for duplicate alias.

Definition at line 104 of file RepoInfoBase.cc.

◆ autorefresh()

bool zypp::repo::RepoInfoBase::autorefresh ( ) const

If true, the repostory must be refreshed before creating resolvables from it.

Definition at line 108 of file RepoInfoBase.cc.

◆ filepath()

Pathname zypp::repo::RepoInfoBase::filepath ( ) const

File where this repo was read from.

Note: could be an empty pathname for repo infos created in memory.

Definition at line 134 of file RepoInfoBase.cc.

◆ setAlias()

void zypp::repo::RepoInfoBase::setAlias ( const std::string & alias )

set the repository alias

See also: alias

Parameters

alias

Definition at line 94 of file RepoInfoBase.cc.

◆ setName()

void zypp::repo::RepoInfoBase::setName ( const std::string & name )

set the repository name

See also: name

Parameters

name

Definition at line 97 of file RepoInfoBase.cc.

◆ setEnabled()

void zypp::repo::RepoInfoBase::setEnabled ( bool enabled )

enable or disable the repository

See also: enabled

Parameters

enabled

Definition at line 88 of file RepoInfoBase.cc.

◆ setAutorefresh()

void zypp::repo::RepoInfoBase::setAutorefresh ( bool autorefresh )

enable or disable autorefresh

See also: autorefresh

Parameters

enabled

Definition at line 91 of file RepoInfoBase.cc.

◆ setFilepath()

void zypp::repo::RepoInfoBase::setFilepath ( const Pathname & filename )

set the path to the .repo file

The path to the .repo file where this repository was defined, or empty if nowhere.

Parameters

path File path

Definition at line 100 of file RepoInfoBase.cc.

◆ dumpOn()

std::ostream & zypp::repo::RepoInfoBase::dumpOn ( std::ostream & str ) const

virtual

Write a human-readable representation of this RepoInfoBase object into the str stream.

Useful for logging.

Reimplemented in zypp::RepoInfo.

Definition at line 138 of file RepoInfoBase.cc.

◆ dumpAsIniOn()

std::ostream & zypp::repo::RepoInfoBase::dumpAsIniOn ( std::ostream & str ) const

virtual

Write this RepoInfoBase object into str in a .repo (ini) file format.

Raw values, no variable replacement.

Reimplemented in zypp::RepoInfo, and zypp::ServiceInfo.

Definition at line 150 of file RepoInfoBase.cc.

◆ dumpAsXmlOn()

std::ostream & zypp::repo::RepoInfoBase::dumpAsXmlOn	(	std::ostream &	str,
		const std::string &	content = `""`
	)		const

virtual

Write an XML representation of this object with content (if available).

Repo variables replaced.

Reimplemented in zypp::RepoInfo, and zypp::ServiceInfo.

Definition at line 162 of file RepoInfoBase.cc.

Friends And Related Function Documentation

◆ RepoInfoBase_Ptr

typedef shared_ptr<RepoInfoBase> RepoInfoBase_Ptr

◆ RepoInfoBase_constPtr

typedef shared_ptr<const RepoInfoBase> RepoInfoBase_constPtr

◆ operator<< [1/2]

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

friend

Definition at line 167 of file RepoInfoBase.cc.

◆ operator==()

bool operator==	(	const RepoInfoBase &	lhs,
		const RepoInfoBase &	rhs
	)

◆ operator!=()

bool operator!=	(	const RepoInfoBase &	lhs,
		const RepoInfoBase &	rhs
	)

◆ operator<<() [2/2]

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

Definition at line 167 of file RepoInfoBase.cc.

Member Data Documentation

◆ _pimpl

RWCOW_pointer<Impl> zypp::repo::RepoInfoBase::_pimpl

private

Pointer to implementation.

Definition at line 163 of file RepoInfoBase.h.

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

zypp/repo/RepoInfoBase.h
zypp/repo/RepoInfoBase.cc

Classes

Public Member Functions

Private Attributes

Friends

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ RepoInfoBase() [1/2]

◆ RepoInfoBase() [2/2]

◆ ~RepoInfoBase()

Member Function Documentation

◆ alias()

◆ escaped_alias()

◆ name()

◆ rawName()

◆ label()

◆ asUserString()

◆ enabled()

◆ autorefresh()

◆ filepath()

◆ setAlias()

◆ setName()

◆ setEnabled()

◆ setAutorefresh()

◆ setFilepath()

◆ dumpOn()

◆ dumpAsIniOn()

◆ dumpAsXmlOn()

Friends And Related Function Documentation

◆ RepoInfoBase_Ptr

◆ RepoInfoBase_constPtr

◆ operator<< [1/2]

◆ operator==()

◆ operator!=()

◆ operator<<() [2/2]

Member Data Documentation

◆ _pimpl