libzypp  11.13.5
zypp::ResObject Class Reference

Interface base for resolvable objects (common data). More...

#include <ResObject.h>

Inheritance diagram for zypp::ResObject:

List of all members.

Public Types

typedef ResObject Self
typedef ResTraits< SelfTraitsType
typedef TraitsType::PtrType Ptr
typedef TraitsType::constPtrType constPtr
- Public Types inherited from zypp::Resolvable
typedef TraitsType::KindType Kind

Public Member Functions

template<class _Res >
ResTraits< _Res >::constPtrType asKind () const
 Convert this into a Ptr of a certain Kind.
template<class _Res >
ResTraits< _Res >::PtrType asKind ()
std::string summary (const Locale &lang_r=Locale()) const
 Short text describing the resolvable.
std::string description (const Locale &lang_r=Locale()) const
 Long text describing the resolvable.
std::string insnotify (const Locale &lang_r=Locale()) const
 Installation Notification.
std::string delnotify (const Locale &lang_r=Locale()) const
 De-Installation Notification.
std::string licenseToConfirm (const Locale &lang_r=Locale()) const
 License or agreement to accept.
Vendor vendor () const
 Vendor.
std::string distribution () const
 The distribution string.
std::string cpeId () const
 The Common Platform Enumeration name for this product.
ByteCount installSize () const
 Installed size.
ByteCount downloadSize () const
 Size of the rpm package.
Repository repository () const
RepoInfo repoInfo () const
 RepoInfo associated with the repository providing this resolvable.
unsigned mediaNr () const
 Media number where the resolvable is located 0 if no media access is required.
Date buildtime () const
 build time of the resolvable
Date installtime () const
 Installation time 0 if the resolvable is not installed.
const DiskUsagediskusage () const
 Disk usage per directory A common attribute, although mostly packages require noticeable disk space.
Locale support.
See also:
sat::Solvable
bool supportsLocales () const
bool supportsLocale (const Locale &locale_r) const
bool supportsLocale (const LocaleSet &locales_r) const
 Whether this Solvable supports at least one of the specified locales.
bool supportsRequestedLocales () const
LocaleSet getSupportedLocales () const
- Public Member Functions inherited from zypp::Resolvable
bool isSystem () const
 Whether this represents an installed solvable.
bool onSystemByUser () const
 Whether this is known to be installed on behalf of a user request.
IdString ident () const
 The identifier.
ResKind kind () const
bool isKind (const ResKind &kind_r) const
 Test whether a Solvable is of a certain ResKind.
template<class _Res >
bool isKind () const
std::string name () const
Edition edition () const
Arch arch () const
bool multiversionInstall () const
 Whether different versions of this package can be installed at the same time.
const sat::SolvablesatSolvable () const
 Access the corresponding ::Solvable.
PoolItem poolItem () const
 Access the corresponding PoolItem.
Capabilities dep (Dep which_r) const
 Select by Dep.
Capabilities operator[] (Dep which_r) const
Capabilities provides () const
Capabilities requires () const
Capabilities conflicts () const
Capabilities obsoletes () const
Capabilities recommends () const
Capabilities suggests () const
Capabilities enhances () const
Capabilities supplements () const
Capabilities prerequires () const
CapabilitySet providesNamespace (const std::string &namespace_r) const
 Return the namespaced provides 'namespace([value])[ op edition]' of this Solvable.
CapabilitySet valuesOfNamespace (const std::string &namespace_r) const
 Return 'value[ op edition]' for namespaced provides 'namespace(value)[ op edition]'.
- Public Member Functions inherited from zypp::base::ReferenceCounted
 ReferenceCounted ()
 Default ctor.
 ReferenceCounted (const ReferenceCounted &rhs)
 Copy ctor.
virtual ~ReferenceCounted ()
 Dtor.
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
unsigned refCount () const
 Return reference counter value.
void ref () const
 Add a reference.
void unref () const
 Release a reference.

Protected Member Functions

 ResObject (const sat::Solvable &solvable_r)
 Ctor.
virtual ~ResObject ()
 Dtor.
virtual std::ostream & dumpOn (std::ostream &str) const
 Helper for stream output.
- Protected Member Functions inherited from zypp::Resolvable
 Resolvable (const sat::Solvable &solvable_r)
 Ctor.
virtual ~Resolvable ()
 Dtor.
- Protected Member Functions inherited from zypp::sat::Solvable
 Solvable ()
 Default ctor creates noSolvable.
 Solvable (IdType id_r)
 PoolImpl ctor.
template<class _Iterator >
bool isKind (_Iterator begin, _Iterator end)
std::string asString () const
 String representation "ident-edition.arch" or "noSolvable".
bool identical (Solvable rhs) const
 Test whether two Solvables have the same content.
bool sameNVRA (Solvable rhs) const
 Test for same name-version-release.arch.
Solvable nextInPool () const
 Return next Solvable in Pool (or noSolvable).
Solvable nextInRepo () const
 Return next Solvable in Repo (or noSolvable).
::_Solvable * get () const
 Expert backdoor.
IdType id () const
 Expert backdoor.
std::string lookupStrAttribute (const SolvAttr &attr) const
 returns the string attribute value for attr or an empty string if it does not exists.
std::string lookupStrAttribute (const SolvAttr &attr, const Locale &lang_r) const
unsigned long long lookupNumAttribute (const SolvAttr &attr) const
 returns the numeric attribute value for attr or 0 if it does not exists.
bool lookupBoolAttribute (const SolvAttr &attr) const
 returns the boolean attribute value for attr or false if it does not exists.
detail::IdType lookupIdAttribute (const SolvAttr &attr) const
 returns the id attribute value for attr or detail::noId if it does not exists.
CheckSum lookupCheckSumAttribute (const SolvAttr &attr) const
 returns the CheckSum attribute value for attr or an empty CheckSum if ir does not exist.
OnMediaLocation lookupLocation () const
 returns OnMediaLocation data: This is everything we need to download e.g.
void getSupportedLocales (LocaleSet &locales_r) const
 Return the supported locales via locales_r.
- Protected Member Functions inherited from zypp::base::ReferenceCounted
virtual void ref_to (unsigned) const
 Trigger derived classes after refCount was increased.
virtual void unref_to (unsigned) const
 Trigger derived classes after refCount was decreased.

Friends

ResObject::Ptr makeResObject (const sat::Solvable &solvable_r)
 Create ResObject from sat::Solvable.

Related Functions

(Note that these are not member functions.)

template<class _Res >
ResTraits< _Res >::PtrType asKind (const ResObject::Ptr &p)
 Convert ResObject::Ptr into Ptr of a certain Kind.
bool isKind (const Resolvable::constPtr &p)
bool isKind (const sat::Solvable &solvable_r)

Detailed Description

Interface base for resolvable objects (common data).

That is, all data not needed for solving, but common across all Resolvable kinds.

See also:
makeResObject for how to construct ResObjects.

Definition at line 44 of file ResObject.h.


Member Typedef Documentation

Reimplemented from zypp::Resolvable.

Reimplemented in zypp::Patch, zypp::Package, zypp::Product, zypp::Pattern, and zypp::SrcPackage.

Definition at line 47 of file ResObject.h.

Reimplemented from zypp::Resolvable.

Reimplemented in zypp::Patch, zypp::Package, zypp::Product, zypp::Pattern, and zypp::SrcPackage.

Definition at line 48 of file ResObject.h.

Reimplemented from zypp::Resolvable.

Reimplemented in zypp::Patch, zypp::Package, zypp::Product, zypp::Pattern, and zypp::SrcPackage.

Definition at line 49 of file ResObject.h.


Constructor & Destructor Documentation

zypp::ResObject::ResObject ( const sat::Solvable solvable_r)
protected

Ctor.

Definition at line 34 of file ResObject.cc.

zypp::ResObject::~ResObject ( )
protectedvirtual

Dtor.

Definition at line 43 of file ResObject.cc.


Member Function Documentation

template<class _Res >
ResTraits< _Res >::constPtrType zypp::ResObject::asKind ( ) const
inline

Convert this into a Ptr of a certain Kind.

This is a convenience to access type specific attributes.

Returns:
NULL if this is not of the specified kind.
PoolItem pi;
Package::constPtr pkg = pi->asKind<Package>();
if ( pi->isKind<Package>() )
DBG << pi->asKind<Package>()->keywords() << endl;

Definition at line 267 of file ResObject.h.

template<class _Res >
ResTraits< _Res >::PtrType zypp::ResObject::asKind ( )
inline

Definition at line 271 of file ResObject.h.

bool zypp::ResObject::supportsLocales ( ) const
inline
See also:
sat::Solvable::supportsLocales

Reimplemented from zypp::sat::Solvable.

Definition at line 78 of file ResObject.h.

bool zypp::ResObject::supportsLocale ( const Locale locale_r) const
inline
See also:
sat::Solvable::supportsLocale

Reimplemented from zypp::sat::Solvable.

Definition at line 82 of file ResObject.h.

bool zypp::ResObject::supportsLocale ( const LocaleSet locales_r) const
inline

Whether this Solvable supports at least one of the specified locales.

Reimplemented from zypp::sat::Solvable.

Definition at line 85 of file ResObject.h.

bool zypp::ResObject::supportsRequestedLocales ( ) const
inline
See also:
sat::Solvable::supportsRequestedLocales

Reimplemented from zypp::sat::Solvable.

Definition at line 89 of file ResObject.h.

LocaleSet zypp::ResObject::getSupportedLocales ( ) const
inline
See also:
sat::Solvable::getSupportedLocales

Reimplemented from zypp::sat::Solvable.

Definition at line 93 of file ResObject.h.

std::string zypp::ResObject::summary ( const Locale lang_r = Locale()) const

Short text describing the resolvable.

This attribute is usually displayed in columns.

Definition at line 58 of file ResObject.cc.

std::string zypp::ResObject::description ( const Locale lang_r = Locale()) const

Long text describing the resolvable.

Definition at line 61 of file ResObject.cc.

std::string zypp::ResObject::insnotify ( const Locale lang_r = Locale()) const

Installation Notification.

This text can be used to tell the user some notes When he selects the resovable for installation.

Definition at line 64 of file ResObject.cc.

std::string zypp::ResObject::delnotify ( const Locale lang_r = Locale()) const

De-Installation Notification.

This text can be used to tell the user some notes When he selects the resovable for deinstall.

Definition at line 67 of file ResObject.cc.

std::string zypp::ResObject::licenseToConfirm ( const Locale lang_r = Locale()) const

License or agreement to accept.

Agreement, warning or license the user should accept before installing the resolvable.

Definition at line 70 of file ResObject.cc.

Vendor zypp::ResObject::vendor ( ) const
inline

Vendor.

For example "Novell Inc."

Reimplemented from zypp::sat::Solvable.

Definition at line 138 of file ResObject.h.

std::string zypp::ResObject::distribution ( ) const

The distribution string.

E.g. code-11.

Reimplemented in zypp::Package.

Definition at line 78 of file ResObject.cc.

std::string zypp::ResObject::cpeId ( ) const

The Common Platform Enumeration name for this product.

See http://cpe.mitre.org

Definition at line 81 of file ResObject.cc.

ByteCount zypp::ResObject::installSize ( ) const

Installed size.

Definition at line 84 of file ResObject.cc.

ByteCount zypp::ResObject::downloadSize ( ) const

Size of the rpm package.

Definition at line 87 of file ResObject.cc.

Repository zypp::ResObject::repository ( ) const
inline
See also:
sat::Solvable::repository

Reimplemented from zypp::sat::Solvable.

Definition at line 161 of file ResObject.h.

RepoInfo zypp::ResObject::repoInfo ( ) const
inline

RepoInfo associated with the repository providing this resolvable.

Definition at line 167 of file ResObject.h.

unsigned zypp::ResObject::mediaNr ( ) const

Media number where the resolvable is located 0 if no media access is required.

Definition at line 90 of file ResObject.cc.

Date zypp::ResObject::buildtime ( ) const

build time of the resolvable

Definition at line 93 of file ResObject.cc.

Date zypp::ResObject::installtime ( ) const

Installation time 0 if the resolvable is not installed.

Definition at line 96 of file ResObject.cc.

const DiskUsage & zypp::ResObject::diskusage ( ) const

Disk usage per directory A common attribute, although mostly packages require noticeable disk space.

An e.g product could try to reserve a certain ammount of diskspace by providing DiskUsage data.

Definition at line 100 of file ResObject.cc.

std::ostream & zypp::ResObject::dumpOn ( std::ostream &  str) const
protectedvirtual

Helper for stream output.

Reimplemented from zypp::Resolvable.

Definition at line 51 of file ResObject.cc.


Friends And Related Function Documentation

ResObject::Ptr makeResObject ( const sat::Solvable solvable_r)
friend

Create ResObject from sat::Solvable.

This function creates the apropriate kind of ResObject depending on the sat::Solvables kind, and returns a smart pointer to it.

If the sat::Solvables kind is not convertible, a NULL pointer is returned.

sat::Solvable s;
Package::Ptr pkg( make<Package>( s ) );

Definition at line 116 of file ResObject.cc.

template<class _Res >
ResTraits< _Res >::PtrType asKind ( const ResObject::Ptr p)
related

Convert ResObject::Ptr into Ptr of a certain Kind.

Returns:
NULL iff p is NULL or points to a Resolvable not of the specified Kind.
asKind<Package>(resPtr);

Reimplemented from zypp::Resolvable.

Definition at line 259 of file ResObject.h.


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