libzypp  15.3.0
Classes | Public Types | Public Member Functions | Private Attributes | Related Functions | List of all members
zypp::ZYppCommitResult Class Reference

Result returned from ZYpp::commit. More...

#include <ZYppCommitResult.h>

Classes

class  Impl
 

Public Types

typedef std::vector< sat::Transaction::Step > TransactionStepList
 

Public Member Functions

 ZYppCommitResult ()
 
 ZYppCommitResult (const ZYppCommitResult &lhs_r)
 
 ZYppCommitResult (const Pathname &root_r)
 
 ~ZYppCommitResult ()
 
const Pathname & root () const
 Remembered root directory of the target. More...
 
const sat::Transaction & transaction () const
 The full transaction list. More...
 
sat::Transaction & rTransaction ()
 Manipulate transaction. More...
 
const TransactionStepList & transactionStepList () const
 List of sat::Transaction::Step to be executed by commit. More...
 
TransactionStepList & rTransactionStepList ()
 Manipulate transactionStepList. More...
 
const UpdateNotifications & updateMessages () const
 List of update messages installed during this commit. More...
 
UpdateNotifications & rUpdateMessages ()
 Manipulate updateMessages Pathnames are relative to the targets root directory. More...
 
Some statistics based on \ref Transaction

Class Transaction allows to count and iterate the action steps to get more detailed information about the transaction result.

Here are just a few convenience methods for easy evaluation.

ZYppCommitResult result;
const sat::Transaction & trans( result.transaction() );
for_( it, trans.actionBegin(~sat::Transaction::STEP_DONE), trans.actionEnd() )
{
// process all steps not DONE (ERROR and TODO)
if ( it->satSolvable() )
std::cout << it->satSolvable() << endl;
else // deleted @System solvable: print post mortem data available
std::cout << it->ident() << endl;
}
See also
Transaction, transaction()
bool allDone () const
 Whether all steps were performed successfully (none skipped or error) More...
 
bool noError () const
 Whether an error ocurred (skipped streps are ok). More...
 

Private Attributes

RWCOW_pointer< Impl > _pimpl
 Pointer to data. More...
 

Related Functions

(Note that these are not member functions.)

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

Detailed Description

Result returned from ZYpp::commit.

Note
Transaction data are provided and maintained during commit. Though the interface does not inhibit manipulation of transaction data outside commit (those methods could have been made private:), this is not recommended as you may easily mess up things.
See also
ZYpp::commit

Definition at line 62 of file ZYppCommitResult.h.

Member Typedef Documentation

typedef std::vector<sat::Transaction::Step> zypp::ZYppCommitResult::TransactionStepList

Definition at line 65 of file ZYppCommitResult.h.

Constructor & Destructor Documentation

zypp::ZYppCommitResult::ZYppCommitResult ( )

Definition at line 52 of file ZYppCommitResult.cc.

zypp::ZYppCommitResult::ZYppCommitResult ( const ZYppCommitResult &  lhs_r)

Definition at line 56 of file ZYppCommitResult.cc.

zypp::ZYppCommitResult::ZYppCommitResult ( const Pathname &  root_r)

Definition at line 60 of file ZYppCommitResult.cc.

zypp::ZYppCommitResult::~ZYppCommitResult ( )

Definition at line 64 of file ZYppCommitResult.cc.

Member Function Documentation

const Pathname & zypp::ZYppCommitResult::root ( ) const

Remembered root directory of the target.

Pathnames within this class are relative to the targets root directory.

Definition at line 67 of file ZYppCommitResult.cc.

const sat::Transaction & zypp::ZYppCommitResult::transaction ( ) const

The full transaction list.

The complete list including transaction steps that do not require any action (like obsoletes or non-package actions). Depending on ZYppCommitPolicy::restrictToMedia only a subset of this transaction might have been executed.

See also
transactionStepList.

Definition at line 70 of file ZYppCommitResult.cc.

sat::Transaction & zypp::ZYppCommitResult::rTransaction ( )

Manipulate transaction.

Definition at line 73 of file ZYppCommitResult.cc.

const ZYppCommitResult::TransactionStepList & zypp::ZYppCommitResult::transactionStepList ( ) const

List of sat::Transaction::Step to be executed by commit.

The list of transaction step commit actually tried to execute.

Definition at line 76 of file ZYppCommitResult.cc.

ZYppCommitResult::TransactionStepList & zypp::ZYppCommitResult::rTransactionStepList ( )

Manipulate transactionStepList.

Definition at line 79 of file ZYppCommitResult.cc.

const UpdateNotifications & zypp::ZYppCommitResult::updateMessages ( ) const

List of update messages installed during this commit.

Pathnames are relative to the targets root directory.

ZYppCommitResult result;
...
if ( ! result.updateMessages().empty() )
{
MIL << "Received " << result.updateMessages().size() << " update notification(s):" << endl;
for_( it, result.updateMessages().begin(), result.updateMessages().end() )
{
MIL << "- From " << it->solvable().asString() << " in file " << Pathname::showRootIf( result.root(), it->file() ) << ":" << endl;
{
// store message files content in a string:
InputStream istr( Pathname::assertprefix( result.root(), it->file() ) );
std::ostringstream strstr;
iostr::copy( istr, strstr );
std::string message( strstr.str() ); // contains the message
}
{
// or write out the message file indented:
InputStream istr( Pathname::assertprefix( result.root(), it->file() ) );
iostr::copyIndent( istr, MIL, "> " ) << endl;
}
}
}

Definition at line 82 of file ZYppCommitResult.cc.

UpdateNotifications & zypp::ZYppCommitResult::rUpdateMessages ( )

Manipulate updateMessages Pathnames are relative to the targets root directory.

Definition at line 85 of file ZYppCommitResult.cc.

bool zypp::ZYppCommitResult::allDone ( ) const
inline

Whether all steps were performed successfully (none skipped or error)

Definition at line 158 of file ZYppCommitResult.h.

bool zypp::ZYppCommitResult::noError ( ) const
inline

Whether an error ocurred (skipped streps are ok).

Definition at line 162 of file ZYppCommitResult.h.

Friends And Related Function Documentation

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

Stream output.

Definition at line 90 of file ZYppCommitResult.cc.

Member Data Documentation

RWCOW_pointer<Impl> zypp::ZYppCommitResult::_pimpl
private

Pointer to data.

Definition at line 168 of file ZYppCommitResult.h.

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