BinItem.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//

#ifndef BINITEM_H
#define BINITEM_H

#include <iostream>

#include "RealVect.H"


class BinItem
{
public:
  BinItem();

  BinItem(const RealVect& a_position);

  virtual ~BinItem();

  virtual void define(const RealVect& a_position);

  void setPosition(const RealVect& a_position);

  void setPosition(const Real a_position, const int a_dimension);

  RealVect& position();

  const RealVect& position() const;

  Real position(const int a_dir) const;

  // Linearization functions


  virtual int size() const;


  virtual void linearOut(void* a_buf) const;


  virtual void linearIn(void* a_buf);

  int preAllocatable() {return 0;}

  // Text output functions

  virtual void print() const;
  friend std::ostream& operator<<( std::ostream& ostr, const BinItem& a_item );

protected:
  RealVect m_position;
};

std::ostream& operator<<( std::ostream& ostr, const BinItem& a_item );

#endif

---