BaseWorldUtility.h

/* -*- mode:c++ -*- ********************************************************
 * file:        BaseWorldUtility.h
 *
 * author:      Tom Parker
 *
 * copyright:   (C) 2007 Parallel and Distributed Systems Group (PDS) at
 *              Technische Universiteit Delft, The Netherlands.
 *
 *              This program 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.
 *              For further information see file COPYING
 *              in the top level directory
 ***************************************************************************
 * description: basic world utility class
 *              provides world-required values
 **************************************************************************/

#ifndef BASE_WORLD_UTIL_H
#define BASE_WORLD_UTIL_H

#include "Blackboard.h"
#include "Coord.h"

class BaseWorldUtility : public Blackboard
{
protected:
    Coord playgroundSize;

    bool useTorusFlag;

    bool use2DFlag;

    long airFrameId;

    bool isInitialized;

public:
  static const double speedOfLight;

protected:
    virtual void initializeIfNecessary();

public:
  BaseWorldUtility();

  virtual void initialize(int stage);

    const Coord* getPgs(){
      initializeIfNecessary();
        return &playgroundSize;
    };

    bool useTorus(){
      initializeIfNecessary();
      return useTorusFlag;
    };

  virtual Coord getRandomPosition();

    bool use2D()
    {
      initializeIfNecessary();
      return use2DFlag;
    }

    long getUniqueAirFrameId()
    {
      initializeIfNecessary();

      // if counter has done one complete cycle and will be set to a value it already had
      if (airFrameId == -1){
        // print a warning
        ev << "WARNING: AirFrameId-Counter has done one complete cycle."
        << " AirFrameIds are repeating now and may not be unique anymore." << endl;
      }

      return airFrameId++;
    }
 };

#endif