CargoHolder.h

Go to the documentation of this file.

/*
Copyright 2003 - 2005 Elliott Kleinrock, Dan Neely, Kurt W. Over, Damon Domjan

This file is part of FreeStars, a free clone of the Stars! game.

FreeStars is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

FreeStars is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with FreeStars; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

The full GPL Copyright notice should be in the file COPYING.txt

Contact:
Email Elliott at 9jm0tjj02@sneakemail.com
*/

#if !defined(CargoHolder_h)
#define CargoHolder_h

#include <deque>
using namespace std;

class Player;

#include "FSTypes.h"
#include "Rules.h"
#include "Location.h"

const long SEEN_OWNER                   = 0x00000001;   // who owns it
const long SEEN_HULL                    = 0x00000002;   // hull of ship or base for planets
const long SEEN_DESIGN                  = 0x00000004;   // full design of ship or base, additional special check for certain races (WM)
const long SEEN_PLANETHAB               = 0x00000008;   // current and starting planetary hab, owners hab is special case for certain races (CA)
const long SEEN_PLANETMC                = 0x00000010;   // mineral concentrations
const long SEEN_PLANETPOP               = 0x00000020;   // display planet pop (actual shown to host and owner)
const long SEEN_INSTALLATIONS   = 0x00000040;   // stuff on the ground
const long SEEN_ORDERS                  = 0x00000080;   // orders
const long SEEN_SCANNER                 = SEEN_OWNER | SEEN_HULL;
const long SEEN_PENSCAN                 = SEEN_OWNER | SEEN_PLANETHAB | SEEN_PLANETMC | SEEN_PLANETPOP;
const long SEEN_BYOWNER                 = 0x0000FFFF;   // what the Owner sees
const long SEEN_HOST                    = 0xFFFFFFFF;   // what the Host sees

class CargoHolder : public Location {
public:
        CargoHolder() : Location(), mOwner(NULL), mAlsoHere(NULL) { Init(); }
        CargoHolder(const CargoHolder &source) : Location(source), mOwner(source.mOwner), mAlsoHere(NULL) { Init(); }
//      CargoHolder(int x, int y, Player * owner) : Location(x, y), mOwner(owner) { Init(); }
        virtual ~CargoHolder();
        void Init();
        bool ParseNode(const TiXmlNode * node, Player * player);
        virtual bool ParseNode(const TiXmlNode * node);
        virtual TiXmlNode * WriteNode(TiXmlNode * node, const Player * viewer) const;
        long GetPopulation() const      { return mPopulation; }
        TiXmlNode * WriteTransport(TiXmlNode * node) const;

        virtual long GetID() const              { return mID; }
        void SetID(long id)             { mID = id; }
        void AdjustPopulation(long amount)      { this->mPopulation += amount; }
        void AdjustAmounts(long i, long amount);
        void ProcessUnload(CargoHolder * dest, long ct, TransferType tt, long value);   // value usage depends on TransferType
        void ProcessLoad(CargoHolder * dest, long ct, TransferType tt, long value, bool dunnage);       // value usage depends on TransferType
        void TransferCargo(CargoHolder * dest, long ct, long * amount, Player * player);
        virtual long GetCargoCapacity() const = 0;
        virtual long GetContain(long ct) const;
        long GetCargoMass() const;
        const Player * GetOwner() const { return mOwner; }
        Player * NCGetOwner() const             { return mOwner; }

        virtual long SeenBy(const Player * p) const;
        virtual long SeenBy(unsigned long p) const;
        virtual void SetSeenBy(long p, long seen)               { mSeenBy[p] |= seen; }
        virtual long GetCloak(const Player * player, bool pen) const = 0;
        virtual double GetMaxTachyon() const = 0;
        virtual long GetScanPen() const = 0;
        virtual long GetScanSpace() const = 0;
        virtual bool CanLoadBy(const Player * player) const = 0;
        virtual void SetCanLoadBy(const Player * player) = 0;
        virtual void ResetSeen();
        virtual bool CanStealShip() const       { return false; }
        virtual bool CanStealPlanet() const     { return false; }

        void SetAlsoHere(deque<CargoHolder *> * locs)   { mAlsoHere = locs; }
        deque<CargoHolder *> * GetAlsoHere()                    { return mAlsoHere; }
        const deque<CargoHolder *> * GetAlsoHere() const        { return mAlsoHere; }

protected:
        static long TransferAmount(long ct, CargoHolder * from, CargoHolder * to, long Request);
        long mPopulation;
        deque<long> mContains;
        deque<long> mSeenBy;
        Player * mOwner;
        long mID;
        deque<CargoHolder *> * mAlsoHere;
};

#endif // !defined(CargoHolder_h)

---