src/IplPaws/PawsPtclAttribDataSource.h

Go to the documentation of this file.

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 *
 * Visit http://people.web.psi.ch/adelmann/ for more details
 *
 ***************************************************************************/

#ifndef PAWS_PARTICLE_ATTRIB_DATA_SOURCE_H
#define PAWS_PARTICLE_ATTRIB_DATA_SOURCE_H

/***********************************************************************
 * 
 * class PawsParticleAttribDataSource
 *
 * PawsParticleAttribDataSource is a specific version of
 * DataSourceObject which takes the data for a given ParticleAttrib
 * and formats it properly for connection to another program via PAWS.
 *
 ***********************************************************************/

// include files
#include "DataSource/DataSourceObject.h"
#include "IpplPaws/PawsType.h"

// forward references
template<class T> class ParticleAttrib;
template<class T> class PawsArrayData;
class PawsDataConnect;


template<class T>
class PawsParticleAttribDataSource : public DataSourceObject {

public:
  // constructor: the name, the connection, the transfer method, the attrib
  PawsParticleAttribDataSource(const char *, DataConnect *, int,
                               ParticleAttrib<T> &);

  // destructor
  virtual ~PawsParticleAttribDataSource();

  //
  // DataSourceObject virtual function interface.
  //

  // Update the object, that is, make sure the receiver of the data has a
  // current and consistent snapshot of the current state.  Return success.
  virtual bool update();

  // Indicate to the receiver that we're allowing them time to manipulate the
  // data (e.g., for a viz program, to rotate it, change representation, etc.)
  // This should only return when the manipulation is done.
  virtual void interact(const char * = 0);

private:
  // The type and size of the type used for the Paws Array
  typedef typename PawsType<T>::Type_t PawsType_t;
  enum { Size = PawsType<T>::Size };

  // The particle attrib object
  ParticleAttrib<T>& attrib;

  // The Paws data structure used to manage the Paws transfer
  PawsArrayData<PawsType_t> *pawsArray;

  // The connection object we're using here
  PawsDataConnect *pawsConnect;

  // Size info, one integer for each node
  int *sizeinfo;
};

// Ostream operator expected by Paws
//
template<class T>
ostream& operator<<(ostream& out, const PawsParticleAttribDataSource<T>& attrib);

#include "IpplPaws/PawsPtclAttribDataSource.cpp"

#endif // PAWS_PARTICLE_ATTRIB_DATA_SOURCE_H

/***************************************************************************
 * $RCSfile: PawsPtclAttribDataSource.h,v $   $Author: adelmann $
 * $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:32 $
 * IPPL_VERSION_ID: $Id: PawsPtclAttribDataSource.h,v 1.1.1.1 2003/01/23 07:40:32 adelmann Exp $ 
 ***************************************************************************/

---