vector.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 NS3_VECTOR_H
#define NS3_VECTOR_H

#include "attribute.h"
#include "attribute-helper.h"

namespace ns3 {

class Vector3D
{
public:
  Vector3D (double _x, double _y, double _z);
  Vector3D ();
  
  double x;  
  double y;  
  double z;  

  double GetLength () const;
  
  friend double CalculateDistance (const Vector3D &a, const Vector3D &b);
  
  friend std::ostream &operator << (std::ostream &os, const Vector3D &vector);

  friend std::istream &operator >> (std::istream &is, Vector3D &vector);

  friend bool operator < (const Vector3D &a, const Vector3D &b);

  friend Vector3D operator + (const Vector3D &a, const Vector3D &b);

  friend Vector3D operator - (const Vector3D &a, const Vector3D &b);
};

class Vector2D
{
public:
  Vector2D (double _x, double _y);
  Vector2D ();
  double x;  
  double y;  

  // works:  /** \copydoc ns3::Vector3D::GetLength() */
  double GetLength () const;
  
  friend double CalculateDistance (const Vector2D &a, const Vector2D &b);
  
  friend std::ostream &operator << (std::ostream &os, const Vector2D &vector);

  friend std::istream &operator >> (std::istream &is, Vector2D &vector);

  friend bool operator < (const Vector2D &a, const Vector2D &b);

  friend Vector2D operator + (const Vector2D &a, const Vector2D &b);

  friend Vector2D operator - (const Vector2D &a, const Vector2D &b);
};

double CalculateDistance (const Vector3D &a, const Vector3D &b);
double CalculateDistance (const Vector2D &a, const Vector2D &b);
std::ostream &operator << (std::ostream &os, const Vector3D &vector);
std::ostream &operator << (std::ostream &os, const Vector2D &vector);
std::istream &operator >> (std::istream &is, Vector3D &vector);
std::istream &operator >> (std::istream &is, Vector2D &vector);
bool operator < (const Vector3D &a, const Vector3D &b); 
bool operator < (const Vector2D &a, const Vector2D &b);
  
ATTRIBUTE_HELPER_HEADER (Vector3D);
ATTRIBUTE_HELPER_HEADER (Vector2D);

typedef Vector3D Vector;

typedef Vector3DValue VectorValue;
  
typedef Vector3DChecker VectorChecker;


// Document these by hand so they go in group attribute_Vector3D
ATTRIBUTE_ACCESSOR_DEFINE (Vector);

Ptr<const AttributeChecker> MakeVectorChecker (void);
  
  
} // namespace ns3

#endif /* NS3_VECTOR_H */