eosim::core::Bin             EoSimulator Programmer's Manual

 

NAME

      Bin: Abstract Bin

 

SYNOPSIS

      #include <eosim/core/bin.hpp>

 

namespace eosim {

namespace core {

 

            class Bin {

            public:

                  virtual ~Bin();

                  void acquire (double amount_);

                  bool isAvailable (double amount_);

                  double getQuantity();

            };

     

}

}

 

DESCRIPTION

This is the parent class of all Bins.

 

CLASS OPERATIONS

~Bin();

      The destructor of Bin.

     

void acquire (double amount_):

            This operation acquires amount_ units of the bin. If the programmer tries to acquire an amount greater than the bin’s actual quantity, the simulation aborts immediately displaying an error message.

           

      bool isAvailable (double amount_):

            This operation returns true if there is enough units of Bin available to fulfill the request.

 

      double getQuantity ():

            This operation returns the actual amount of bins available.

           

 

SEE ALSO

eosim::core::NonRenewable

eosim::core::Renewable