installedpackage.h

Go to the documentation of this file.

/*!\file installedpackage.h
        \brief Declerations for InstalledPackage and PackageUpgrade.
        Should be included wherever InstalledPackages are used.*/

#ifndef __INSTALLEDPACKAGE_H__
#define __INSTALLEDPACKAGE_H__

#include <vector>
#include "pmstring.h"
#include "packageversion.h"
#include "package.h"
#include <db4.1/db_cxx.h>

//!Used to detail a package upgrade.
/*!Used to detail a package upgrade. When executing an upgrade,
   be sure to be responsible and install the new version before removing
   the old one. Also check for errors so the user doesnt get a removed
   package instead of an upgraded one.*/
struct PackageUpgrade
{
        PackageVersion oldVersion;      //!<The old version to upgrade from.
        PackageVersion newVersion;      //!<The new version to upgrade to.
};

//!Details a PackageVersion that is installed.
/*!Details a PackageVersion that is installed. Inherits from PackageVersion.
   Doesn't have many functions, other than DB related ones, essentially just
   adds extra info to PackageVersion*/
class InstalledPackage : public PackageVersion
{
        public:
                InstalledPackage();                                                             //!<Default Constructor.
                InstalledPackage(const InstalledPackage &copy); //!<Copy Constructor.
                InstalledPackage(const PackageVersion &copy);   //!<Copy Constructor.
                InstalledPackage(const Package &copy);                  //!<Copy Constructor.
                virtual ~InstalledPackage();                                    //!<Destructor.
                
                bool operator== (const InstalledPackage& param);        //!<Equality operator.
                bool operator!= (const InstalledPackage& param);        //!<Non equality operator.
                bool operator== (const PackageVersion& param);          //!<Equality operator - with PackageVersion.
                bool operator!= (const PackageVersion& param);          //!<Non equality operator - with PackageVersion.
                bool operator== (const Package& param);                         //!<Equality operator - with Package.
                bool operator!= (const Package& param);                         //!<Non equality operator - with Package.
                
                virtual Dbt GetKey();                   //!<Get DB Key.
                virtual Dbt GetData();                  //!<Get DB Data.
                virtual void ReadData(Dbt data);//!<Read DB Data.
                virtual void ReadKey(Dbt key);  //!<Read DB Key.
                
                bool inWorld;                                   //!<Is the package in World?.
                std::vector<PMString> virtuals; //!<The virtuals provided by the installed package.
                PMString useFlags;                              //!<The useFlags the package was installed with.
        
        protected:
                int _VectorSize(std::vector<PMString> stringVector);    //!<Utility function to get the size of a vector.
};

#endif

---