position-allocator.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef POSITION_ALLOCATOR_H
#define POSITION_ALLOCATOR_H

#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
#include "ns3/vector.h"

namespace ns3 {

class PositionAllocator : public Object
{
public:
  static TypeId GetTypeId (void);
  PositionAllocator ();
  virtual ~PositionAllocator ();
  virtual Vector GetNext (void) const = 0;
  virtual int64_t AssignStreams (int64_t stream) = 0;
};

class ListPositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);
  ListPositionAllocator ();

  void Add (Vector v);
  uint32_t GetSize (void) const;
  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  std::vector<Vector> m_positions;  
  mutable std::vector<Vector>::const_iterator m_current; 
};

class GridPositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);

  enum LayoutType {
    ROW_FIRST,
    COLUMN_FIRST
  };

  GridPositionAllocator ();

  void SetMinX (double xMin);
  void SetMinY (double yMin);
  void SetZ (double z);
  void SetDeltaX (double deltaX);
  void SetDeltaY (double deltaY);
  void SetN (uint32_t n);
  void SetLayoutType (enum LayoutType layoutType);

  double GetMinX (void) const;
  double GetMinY (void) const;
  double GetDeltaX (void) const;
  double GetDeltaY (void) const;
  uint32_t GetN (void) const;
  enum LayoutType GetLayoutType (void) const;


  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  mutable uint32_t m_current; 
  enum LayoutType m_layoutType;  
  double m_xMin; 
  double m_yMin; 
  double m_z; 
  uint32_t m_n;  
  double m_deltaX; 
  double m_deltaY; 
};

class RandomRectanglePositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);
  RandomRectanglePositionAllocator ();
  virtual ~RandomRectanglePositionAllocator ();

  void SetX (Ptr<RandomVariableStream> x);
  void SetY (Ptr<RandomVariableStream> y);
  void SetZ (double z);

  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  Ptr<RandomVariableStream> m_x; 
  Ptr<RandomVariableStream> m_y; 
  double m_z; 
};

class RandomBoxPositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);
  RandomBoxPositionAllocator ();
  virtual ~RandomBoxPositionAllocator ();

  void SetX (Ptr<RandomVariableStream> x);
  void SetY (Ptr<RandomVariableStream> y);
  void SetZ (Ptr<RandomVariableStream> z);

  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  Ptr<RandomVariableStream> m_x; 
  Ptr<RandomVariableStream> m_y; 
  Ptr<RandomVariableStream> m_z; 
};

class RandomDiscPositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);
  RandomDiscPositionAllocator ();
  virtual ~RandomDiscPositionAllocator ();

  void SetTheta (Ptr<RandomVariableStream> theta);
  void SetRho (Ptr<RandomVariableStream> rho);
  void SetX (double x);
  void SetY (double y);
  void SetZ (double z);

  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  Ptr<RandomVariableStream> m_theta; 
  Ptr<RandomVariableStream> m_rho; 
  double m_x; 
  double m_y; 
  double m_z;  
};


class UniformDiscPositionAllocator : public PositionAllocator
{
public:
  static TypeId GetTypeId (void);
  UniformDiscPositionAllocator ();
  virtual ~UniformDiscPositionAllocator ();

  void SetRho (double rho);

  void SetX (double x);

  void SetY (double y);

  void SetZ (double z);

  virtual Vector GetNext (void) const;
  virtual int64_t AssignStreams (int64_t stream);
private:
  Ptr<UniformRandomVariable> m_rv;  
  double m_rho; 
  double m_x;  
  double m_y;  
  double m_z;  
};

} // namespace ns3

#endif /* RANDOM_POSITION_H */