OnMediaLocation.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_SOURCE_ONMEDIALOCATION_H
#define ZYPP_SOURCE_ONMEDIALOCATION_H

#include <iosfwd>

#include "zypp/APIConfig.h"
#include "zypp/Pathname.h"
#include "zypp/ByteCount.h"
#include "zypp/CheckSum.h"

namespace zypp
{ 

  //
  //    CLASS NAME : OnMediaLocation
  //
  class OnMediaLocation
  {
    friend std::ostream & operator<<( std::ostream & str, const OnMediaLocation & obj );

  public:
    OnMediaLocation()
    : _medianr( 0 )
    , _optional(false)
    {}

    OnMediaLocation( const Pathname & filename_r, unsigned medianr_r = 1 )
    : _medianr( medianr_r )
    , _filename( filename_r )
    , _optional(false) // bnc #447010
    {}

  public:
    unsigned          medianr()        const { return _medianr; }
    const Pathname &  filename()       const { return _filename; }
    const CheckSum &  checksum()       const { return _checksum; }
    const ByteCount & downloadSize()   const { return _downloadsize; }
    const ByteCount & openSize()       const { return _opendownloadsize; }
    const CheckSum &  openChecksum()   const { return _openchecksum; }
    const bool optional() const { return _optional; }

  public:
    OnMediaLocation & unsetLocation()
    { _filename = Pathname(); _medianr = 0; return *this; }

    OnMediaLocation & setLocation( const Pathname & val_r,
                                   unsigned mediaNumber_r = 1 )
    { _filename = val_r; _medianr = mediaNumber_r; return *this; }

    OnMediaLocation & setDownloadSize( const ByteCount & val_r )
    { _downloadsize = val_r; return *this; }

    OnMediaLocation & setChecksum( const CheckSum & val_r )
    { _checksum = val_r; return *this; }

    OnMediaLocation & setOpenSize( const ByteCount & val_r )
    { _opendownloadsize = val_r; return *this; }

    OnMediaLocation & setOpenChecksum( const CheckSum & val_r )
    { _openchecksum = val_r; return *this; }

    OnMediaLocation & setOptional( bool val )
    { _optional = val; return *this; }

  public:
    OnMediaLocation & changeMedianr( unsigned val_r )
    { _medianr = val_r; return *this; }

    OnMediaLocation & changeFilename( const Pathname & val_r )
    { _filename = val_r; return *this; }

    OnMediaLocation & prependPath( const Pathname & prefix_r )
    { if ( !prefix_r.emptyOrRoot() ) changeFilename( prefix_r / filename() ); return *this; }

  private:
    unsigned  _medianr;
    Pathname  _filename;
    CheckSum  _checksum;
    ByteCount _downloadsize;
    ByteCount _opendownloadsize;
    CheckSum  _openchecksum;
    bool      _optional;
  };

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

} // namespace zypp
#endif // ZYPP_SOURCE_ONMEDIALOCATION_H