Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Transferrable Class Reference

#include <servicing.h>

Inheritance diagram for Transferrable:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Transferrable (ResourceWatch &s, ResourceWatch &d)
virtual ASCString getName ()=0
virtual int getMax (ContainerBase *c, bool avail)=0
 get maximum amount for that unit.
virtual int getMin (ContainerBase *c, bool avail)=0
virtual int transfer (ContainerBase *target, int delta)=0
virtual int getAmount (const ContainerBase *target)=0
virtual void commit ()=0
virtual bool isExchangable () const =0
ContainerBasegetSrcContainer ()
ContainerBasegetDstContainer ()
bool setDestAmount (long amount)
void showAll ()
int setAmount (ContainerBase *target, int newamount)
void fill (ContainerBase *target)
void empty (ContainerBase *target)
virtual ~Transferrable ()

Public Attributes

SigC::Signal1< void, const
std::string & > 
sigSourceAmount
SigC::Signal1< void, const
std::string & > 
sigDestAmount

Protected Member Functions

ResourceWatchgetResourceWatch (const ContainerBase *unit)
ResourceWatchgetOpposingResourceWatch (const ContainerBase *unit)
ContainerBaseopposingContainer (const ContainerBase *unit)
void show (const ContainerBase *unit)

Protected Attributes

ResourceWatchsource
ResourceWatchdest

Constructor & Destructor Documentation

Transferrable::Transferrable ResourceWatch s,
ResourceWatch d
 

Definition at line 167 of file servicing.cpp.

virtual Transferrable::~Transferrable  )  [inline, virtual]
 

Definition at line 85 of file servicing.h.


Member Function Documentation

virtual void Transferrable::commit  )  [pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

void Transferrable::empty ContainerBase target  ) 
 

Definition at line 203 of file servicing.cpp.

References setAmount().

void Transferrable::fill ContainerBase target  ) 
 

Definition at line 197 of file servicing.cpp.

References getMax(), and setAmount().

virtual int Transferrable::getAmount const ContainerBase target  )  [pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

Referenced by setAmount(), and show().

ContainerBase * Transferrable::getDstContainer  ) 
 

Definition at line 174 of file servicing.cpp.

References dest, and ResourceWatch::getContainer().

Referenced by setDestAmount().

virtual int Transferrable::getMax ContainerBase c,
bool  avail
[pure virtual]
 

get maximum amount for that unit.

Parameters:
c the container for which the maximum amount is calculated
avail If true, the amount is limited by the resources which can actually provided by the other unit. If false, return the storage capacity

Implemented in ResourceTransferrable, and AmmoTransferrable.

Referenced by fill().

virtual int Transferrable::getMin ContainerBase c,
bool  avail
[pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

virtual ASCString Transferrable::getName  )  [pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

Referenced by TransferWidget::TransferWidget().

ResourceWatch & Transferrable::getOpposingResourceWatch const ContainerBase unit  )  [protected]
 

Definition at line 143 of file servicing.cpp.

References getResourceWatch(), and opposingContainer().

Referenced by ResourceTransferrable::getMax(), ResourceTransferrable::getMin(), and ResourceTransferrable::transfer().

ResourceWatch & Transferrable::getResourceWatch const ContainerBase unit  )  [protected]
 

Definition at line 134 of file servicing.cpp.

References assert, dest, ResourceWatch::getContainer(), and source.

Referenced by ResourceTransferrable::getAmount(), ResourceTransferrable::getAvail(), ResourceTransferrable::getMax(), getOpposingResourceWatch(), and ResourceTransferrable::transfer().

ContainerBase * Transferrable::getSrcContainer  ) 
 

Definition at line 169 of file servicing.cpp.

References ResourceWatch::getContainer(), and source.

virtual bool Transferrable::isExchangable  )  const [pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

Referenced by TransferWidget::TransferWidget().

ContainerBase * Transferrable::opposingContainer const ContainerBase unit  )  [protected]
 

Definition at line 148 of file servicing.cpp.

References assert, dest, ResourceWatch::getContainer(), and source.

Referenced by AmmoTransferrable::getMax(), AmmoTransferrable::getMin(), getOpposingResourceWatch(), AmmoTransferrable::transfer(), and ResourceTransferrable::transfer().

int Transferrable::setAmount ContainerBase target,
int  newamount
 

Definition at line 191 of file servicing.cpp.

References getAmount(), and transfer().

Referenced by empty(), fill(), and setDestAmount().

bool Transferrable::setDestAmount long  amount  ) 
 

Definition at line 179 of file servicing.cpp.

References getDstContainer(), and setAmount().

Referenced by TransferWidget::TransferWidget().

void Transferrable::show const ContainerBase unit  )  [protected]
 

Definition at line 157 of file servicing.cpp.

References assert, dest, getAmount(), ResourceWatch::getContainer(), sigDestAmount, sigSourceAmount, source, and ASCString::toString().

Referenced by showAll().

void Transferrable::showAll  ) 
 

Definition at line 185 of file servicing.cpp.

References dest, ResourceWatch::getContainer(), show(), and source.

virtual int Transferrable::transfer ContainerBase target,
int  delta
[pure virtual]
 

Implemented in ResourceTransferrable, and AmmoTransferrable.

Referenced by setAmount().


Member Data Documentation

ResourceWatch& Transferrable::dest [protected]
 

Definition at line 50 of file servicing.h.

Referenced by AmmoTransferrable::commit(), ResourceTransferrable::commit(), getDstContainer(), getResourceWatch(), opposingContainer(), ResourceTransferrable::ResourceTransferrable(), show(), and showAll().

SigC::Signal1<void,const std::string&> Transferrable::sigDestAmount
 

Definition at line 80 of file servicing.h.

Referenced by show(), and TransferWidget::TransferWidget().

SigC::Signal1<void,const std::string&> Transferrable::sigSourceAmount
 

Definition at line 79 of file servicing.h.

Referenced by show(), and TransferWidget::TransferWidget().

ResourceWatch& Transferrable::source [protected]
 

Definition at line 49 of file servicing.h.

Referenced by AmmoTransferrable::commit(), ResourceTransferrable::commit(), getResourceWatch(), getSrcContainer(), opposingContainer(), ResourceTransferrable::ResourceTransferrable(), show(), and showAll().


The documentation for this class was generated from the following files:
Generated on Tue Jun 24 02:21:48 2008 for Advanced Strategic Command by  doxygen 1.4.2