vtkSharedMemoryCommunicator.h

Go to the documentation of this file.

/* $Id: vtkSharedMemoryCommunicator.h,v 1.2 2008/09/26 02:46:13 pfb Exp $ */
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkSharedMemoryCommunicator.h,v $

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef __vtkSharedMemoryCommunicator_h
#define __vtkSharedMemoryCommunicator_h

#include "vtkCommunicator.h"

class vtkThreadedController;
class vtkSharedMemoryCommunicatorMessage;
class vtkSimpleCriticalSection;
class vtkThreadMessager;

class VTK_PARALLEL_EXPORT vtkSharedMemoryCommunicator : public vtkCommunicator
  {
  /****************************************************************************/
                             public:
  vtkTypeRevisionMacro( vtkSharedMemoryCommunicator,vtkCommunicator);
 
  static vtkSharedMemoryCommunicator* New();

  virtual void PrintSelf(ostream& os, vtkIndent indent);

  virtual int Send(int* data, int length, int remoteThreadId, int tag);

  virtual int Send(unsigned long* data, int length, int remoteThreadId, 
                   int tag);

  virtual int Send(char* data, int length, int remoteThreadId, int tag);

  virtual int Send(unsigned char* data, int length, int remoteThreadId, int tag);

  virtual int Send(float* data, int length, int remoteThreadId, int tag);

  virtual int Send(double* data, int length, int remoteThreadId, int tag);
#ifdef VTK_USE_64BIT_IDS

  virtual int Send(vtkIdType* data, int length, int remoteThreadId, int tag);
#endif

  virtual int Send(vtkDataObject* data, int remoteThreadId, int tag);

  virtual int Send(vtkDataArray* data, int remoteThreadId, int tag);

  virtual int Receive(int* data, int length, int remoteThreadId, 
                      int tag);

  virtual int Receive(unsigned long* data, int length, 
                      int remoteThreadId, int tag);

  virtual int Receive(char* data, int length, int remoteThreadId, 
                      int tag);

  virtual int Receive(unsigned char* data, int length, int remoteThreadId, 
                      int tag);

  virtual int Receive(float* data, int length, int remoteThreadId, 
                      int tag);

  virtual int Receive(double* data, int length, int remoteThreadId, 
                      int tag);
#ifdef VTK_USE_64BIT_IDS

  virtual int Receive(vtkIdType* data, int length, int remoteThreadId, 
                      int tag);
#endif

  virtual int Receive(vtkDataObject *data, int remoteThreadId, int tag);

  virtual int Receive(vtkDataArray *data, int remoteThreadId, int tag);

//BTX

  friend class vtkThreadedController;

//ETX

  /****************************************************************************/
                             protected:

  int NumberOfThreads;
  int Initialized;
  void Initialize(int nThreads, int forceDeepCopy);

  int LocalThreadId;
  int WaitingForId;

  int ForceDeepCopy;

  vtkSimpleCriticalSection* MessageListLock;


  vtkSharedMemoryCommunicator** Communicators;

  vtkSharedMemoryCommunicator* Parent;
  
  vtkSharedMemoryCommunicatorMessage *MessageListStart;
  vtkSharedMemoryCommunicatorMessage *MessageListEnd;

  vtkSharedMemoryCommunicator();

  ~vtkSharedMemoryCommunicator();

  int Send(vtkDataObject* object, void *data, int dataLength, 
           int remoteThreadId, int tag);

  int Receive(vtkDataObject* object, void *data, int dataLength, 
              int remoteThreadId, int tag);

  int Send(vtkDataArray* object, int dataLength, 
           int remoteThreadId, int tag);

  int Receive(vtkDataArray* object, int dataLength, 
              int remoteThreadId, int tag);

  vtkSharedMemoryCommunicatorMessage* NewMessage(vtkDataObject* object,
                                                 void* data, 
                                                 int dataLength);
  vtkSharedMemoryCommunicatorMessage* NewMessage(vtkDataArray* object,
                                                 void* data, 
                                                 int dataLength);
  void DeleteMessage(vtkSharedMemoryCommunicatorMessage *message);
  void AddMessage(vtkSharedMemoryCommunicatorMessage *message);
  vtkSharedMemoryCommunicatorMessage* FindMessage(int sendId, int tag);

  vtkThreadMessager* Messager;

  void SignalNewMessage(vtkSharedMemoryCommunicator* receiveCommunicator);

  void WaitForNewMessage();

  /****************************************************************************/
                             private:

  vtkSharedMemoryCommunicator(const vtkSharedMemoryCommunicator&);
  void operator=(const vtkSharedMemoryCommunicator&);
  };

/*
 * $Log: vtkSharedMemoryCommunicator.h,v $
 * Revision 1.2  2008/09/26 02:46:13  pfb
 * Added note about depreciation.
 *
 * Revision 1.1  2006/03/22 13:09:31  pfb
 * Initial rev.
 *
 *
 */

#endif //  __vtkSharedMemoryCommunicator_h

Generated on Sat Nov 22 12:37:19 2008 for Swath Sonar by Doxygen 1.5.1