//===========================================================================
//  $Name: cflowd-2-1-b1 $
//  $Id: CflowdNetMatrix.hh,v 1.5 1998/09/21 19:14:58 dwm Exp $
//===========================================================================
//  CAIDA Copyright Notice
//
//  By accessing this software, cflowd++, you are duly informed
//  of and agree to be bound by the conditions described below in this
//  notice:
//
//  This software product, cflowd++, is developed by Daniel W. McRobb, and
//  copyrighted(C) 1998 by the University of California, San Diego
//  (UCSD), with all rights reserved.  UCSD administers the CAIDA grant,
//  NCR-9711092, under which part of this code was developed.
//
//  There is no charge for cflowd++ software. You can redistribute it
//  and/or modify it under the terms of the GNU General Public License,
//  v.  2 dated June 1991 which is incorporated by reference herein.
//  cflowd++ is distributed WITHOUT ANY WARRANTY, IMPLIED OR EXPRESS, OF
//  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE or that the use
//  of it will not infringe on any third party's intellectual property
//  rights.
//
//  You should have received a copy of the GNU GPL along with cflowd++.
//  Copies can also be obtained from:
//
//    http://www.gnu.org/copyleft/gpl.html
//
//  or by writing to:
//
//    University of California, San Diego
//
//    SDSC/CAIDA
//    9500 Gilman Dr., MS-0505
//    La Jolla, CA 92093 - 0505  USA
//
//  Or contact:
//
//    info@caida.org
//===========================================================================

#ifndef _CFLOWDNETMATRIX_HH_
#define _CFLOWDNETMATRIX_HH_

extern "C" {
#include <sys/types.h>

#include "caida_t.h"
}

#include <map>
#include <iostream.h>

#include "CflowdNetMatrixKey.hh"
#include "CflowdNetMatrixTrafficCounter.hh"
#include "CflowdRawFlow.hh"

typedef  map<CflowdNetMatrixKey, CflowdNetMatrixTrafficCounter, less<CflowdNetMatrixKey> >   CflowdNetMatrixMap_t;

//---------------------------------------------------------------------------
//  class CflowdNetMatrix : public CflowdNetMatrixMap_t
//---------------------------------------------------------------------------
//  This class is used to contain net matrix traffic data in cflowd++.
//  We use a CflowdNetMatrixKey as a key, and a CflowdNetMatrixTrafficCounter
//  to hold packet and byte counters.
//  Note we just inherit from an instantiation of an STL map, then just
//  add a few new member functions.
//---------------------------------------------------------------------------
class CflowdNetMatrix : public CflowdNetMatrixMap_t
{
public:
  typedef CflowdNetMatrixMap_t::iterator        iterator;
  typedef CflowdNetMatrixMap_t::const_iterator  const_iterator;

  //-------------------------------------------------------------------------
  //                 int AddFlow(const CflowdRawFlow & flow)
  //.........................................................................
  //  Adds the data from a raw flow to the net matrix.  Returns 0 on
  //  success, -1 on failure.
  //-------------------------------------------------------------------------
  int AddFlow(const CflowdRawFlow & flow);
  
  //-------------------------------------------------------------------------
  //                      istream & read(istream & is)
  //.........................................................................
  //  Reads the contents of a net matrix from an istream.  Returns the
  //  istream.
  //-------------------------------------------------------------------------
  istream & read(istream & is);
  
  //-------------------------------------------------------------------------
  //                            int read(int fd)
  //.........................................................................
  //  Reads the contents of a net matrix from a file descriptor.
  //  Returns the number of bytes read on success, -1 on failure.
  //-------------------------------------------------------------------------
  int read(int fd);
  
  //-------------------------------------------------------------------------
  //                   ostream & write(ostream & os) const
  //.........................................................................
  //  Writes the contents of a net matrix to an ostream.  Returns
  //  the ostream.
  //-------------------------------------------------------------------------
  ostream & write(ostream & os) const;
  
  //-------------------------------------------------------------------------
  //                         int write(int fd) const
  //.........................................................................
  //  Writes the contents of a net matrix to a file descriptor.
  //  Returns the number of bytes written on success, -1 on failure.
  //-------------------------------------------------------------------------
  int write(int fd) const;
  
  //-------------------------------------------------------------------------
  //    friend ostream & operator << (ostream& os,               
  //                                  const CflowdNetMatrix & netMatrix)
  //.........................................................................
  //  Overloaded ostream '<<' operator to dump the contents of a
  //  met matrix to an ostream in a human-readable form.
  //-------------------------------------------------------------------------
  friend ostream & operator << (ostream& os,
                                const CflowdNetMatrix & netMatrix);
};

#endif  // _CFLOWDNETMATRIX_HH_