src/IplPaws/PawsScalarDataSource.h

Go to the documentation of this file.

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

#ifndef PAWS_SCALAR_DATA_SOURCE_H
#define PAWS_SCALAR_DATA_SOURCE_H

/***********************************************************************
 * 
 * class PawsScalarDataSource
 *
 * PawsScalarDataSource is a specific version of DataSourceObject connects
 * with a Paws application
 *
 ***********************************************************************/

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

// forward references
template<class T> class ScalarDataSource;
template<class T> class PawsScalarData;
class PawsDataConnect;


template<class T>
class PawsScalarDataSource : public DataSourceObject {

public:

  // constructor: the name, the connection, the transfer method,
  // the scalar to connect, and the parent node.
  PawsScalarDataSource(const char *, DataConnect *, int, ScalarDataSource<T>&);

  // destructor
  virtual ~PawsScalarDataSource();

  //
  // virtual function interface.
  //
  
  // Register an object as something that can be a source of data.
  

  // 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:
  // DataSource Object
  ScalarDataSource<T> &scalarDataSource;

  // Scalar
  T &myScalar;

  // The Paws scalar data object used to send/receive data
  PawsScalarData<T> *pawsdata;

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

#include "IpplPaws/PawsScalarDataSource.cpp"

#endif  // PAWS_SCALAR_DATA_SOURCE_H

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

---