package.h

Go to the documentation of this file.

/*!\file package.h
        \brief Declerations for Package and the MaskedStatus enum.
        Should be included wherever Packages are used.*/
        
#ifndef __PACKAGE_H__
#define __PACKAGE_H__

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

//!Enum for Package masked status.
/*!Enum for the Package masked status. Only four status' at
  the moment.*/
enum MaskedStatus
{
        eHardMasked = 0,        //!<Not to be installed under any circumstances ( as a guide ).
        eUnstable,                      //!<Caution needed.
        eStable,                        //!<Can be installed with no worries.
        eVersionSpecific        //!<Look at the version mask info.
};

//!The Package class.
/*!The Package class. Contains all the info specific to a package. Package Version inherits
  from this. Contains a few methods that should not be used if it can be helped.*/
class Package
{
        public:
                Package();                                                                                                              //!<Default Constructor.
                Package(PMString description);                                                                  //!<Constructor - only supply the description, looks up other things.
                Package(PMString category, PMString name);                                              //!<Constructor - suppy name and category.
                Package(PMString category, PMString name, MaskedStatus state);  //!<Constructor - supply all info.
                Package(const Package &copy);                                                                   //!<Copy Constructor.
                virtual ~Package();                                                                                             //!<Destructor.
                
                bool operator== (const Package& param);                 //!<Equality operator.
                bool operator!= (const Package& param);                 //!<Non equality operator.
        
                virtual Dbt GetKey();                   //!<Return the Key used by DB.
                virtual Dbt GetData();                  //!<Return the Data used by DB.
                virtual void ReadData(Dbt data);//!<Read the Data used by DB.
                virtual void ReadKey(Dbt key);  //!<Read the Key used by DB.
        
                PMString name;                                  //!<Package Name.
                PMString category;                              //!<Package Category.
                PMString url;                                   //!<Package url.
                PMString description;                   //!<Package description.
                MaskedStatus packageMaskedState;//!<Masked State for this system, set by user.
        
        protected:
                std::vector<PMString> _GetInfo(PMString description);   //!<Given a description, returns vector of package info.
                std::vector<PMString> _FindCategories(PMString name);   //!<Given a name, returns a vector of possible categories.
};

#endif

---