Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkProcessModule Class Reference

#include <vtkProcessModule.h>

Inheritance diagram for vtkProcessModule:

Inheritance graph
[legend]
Collaboration diagram for vtkProcessModule:

Collaboration graph
[legend]
List of all members.

Public Types

enum  ProgressEventEnum { PROGRESS_EVENT_TAG = 31415 }
enum  CommunicationIds {
  MultiDisplayDummy = 948346, MultiDisplayRootRender, MultiDisplaySatelliteRender, MultiDisplayInfo,
  PickBestProc, PickBestDist2, IceTWinInfo, IceTNumTilesX,
  IceTNumTilesY, IceTTileRanks, IceTRenInfo, GlyphNPointsGather,
  GlyphNPointsScatter, TreeCompositeDataFlag, TreeCompositeStatus, DuplicatePDNProcs,
  DuplicatePDNRecLen, DuplicatePDNAllBuffers, IntegrateAttrInfo, IntegrateAttrData,
  PickMakeGIDs, TemporalPickHasData, TemporalPicksData
}
enum  ServerFlags {
  DATA_SERVER = 0x1, DATA_SERVER_ROOT = 0x2, RENDER_SERVER = 0x4, RENDER_SERVER_ROOT = 0x8,
  CLIENT = 0x10, CLIENT_AND_SERVERS = DATA_SERVER | CLIENT | RENDER_SERVER
}

Public Member Functions

 vtkTypeRevisionMacro (vtkProcessModule, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
vtkDataObject * GetDataObjectOfType (const char *classname)
virtual int Start (int, char **)=0
virtual void Exit ()=0
virtual vtkObjectBaseGetObjectFromID (vtkClientServerID)
virtual const vtkClientServerStream & GetLastResult (vtkTypeUInt32 server)
virtual vtkClientServerInterpreter * GetInterpreter ()
virtual int GetPartitionId ()
virtual int GetNumberOfPartitions ()
vtkClientServerID GetUniqueID ()
vtkClientServerID GetProcessModuleID ()
void RegisterProgressEvent (vtkObject *po, int id)
void PrepareProgress ()
void CleanupPendingProgress ()
void ExecuteEvent (vtkObject *o, unsigned long event, void *calldata)
void SetGUIHelper (vtkProcessModuleGUIHelper *)
ofstream * GetLogFile ()
virtual void CreateLogFile ()
virtual void GatherInformation (vtkPVInformation *info, vtkClientServerID id)
virtual void GatherInformationRenderServer (vtkPVInformation *info, vtkClientServerID id)
virtual void GatherInformationInternal (const char *infoClassName, vtkObject *object)
vtkClientServerID NewStreamObject (const char *, vtkClientServerStream &stream)
void DeleteStreamObject (vtkClientServerID, vtkClientServerStream &stream)
int SendStream (vtkTypeUInt32 server, vtkClientServerStream &stream, int resetStream=1)
virtual void InitializeInterpreter ()
virtual void FinalizeInterpreter ()
void Initialize ()
void Finalize ()
virtual int GetReportInterpreterErrors ()
virtual void SetReportInterpreterErrors (int)
virtual void ReportInterpreterErrorsOn ()
virtual void ReportInterpreterErrorsOff ()
virtual vtkMultiProcessController * GetController ()
virtual void SendPrepareProgress ()
virtual void SendCleanupPendingProgress ()
vtkCommand * GetObserver ()
virtual void SetLocalProgress (const char *filter, int progress)=0
virtual int GetProgressRequests ()
virtual void SetProgressRequests (int)
virtual vtkPVProgressHandlerGetProgressHandler ()
virtual void SetProgressEnabled (int)
virtual int GetProgressEnabled ()
virtual vtkPVOptionsGetOptions ()
virtual void SetOptions (vtkPVOptions *op)

Static Public Member Functions

int GetRootId (int serverId)
vtkProcessModuleGetProcessModule ()
void SetProcessModule (vtkProcessModule *pm)

Protected Member Functions

 vtkProcessModule ()
 ~vtkProcessModule ()
virtual void InterpreterCallback (unsigned long eid, void *)
virtual const char * DetermineLogFilePrefix ()
void ProgressEvent (vtkObject *o, int val, const char *filter)
virtual vtkTypeUInt32 CreateSendFlag (vtkTypeUInt32 servers)
virtual int SendStreamToClient (vtkClientServerStream &)
virtual int SendStreamToDataServer (vtkClientServerStream &)
virtual int SendStreamToDataServerRoot (vtkClientServerStream &)
virtual int SendStreamToRenderServer (vtkClientServerStream &)
virtual int SendStreamToRenderServerRoot (vtkClientServerStream &)
virtual const vtkClientServerStream & GetLastDataServerResult ()
virtual const vtkClientServerStream & GetLastRenderServerResult ()
virtual const vtkClientServerStream & GetLastClientResult ()

Static Protected Member Functions

void InterpreterCallbackFunction (vtkObject *caller, unsigned long eid, void *cd, void *d)

Protected Attributes

vtkMultiProcessController * Controller
vtkPVInformationTemporaryInformation
vtkClientServerInterpreter * Interpreter
vtkClientServerStream * ClientServerStream
vtkClientServerID UniqueID
vtkCallbackCommand * InterpreterObserver
int ReportInterpreterErrors
vtkProcessModuleInternals * Internals
vtkPVProgressHandlerProgressHandler
int ProgressRequests
int ProgressEnabled
vtkProcessModuleObserver * Observer
vtkPVOptionsOptions
vtkProcessModuleGUIHelperGUIHelper
ofstream * LogFile
vtkKWProcessStatisticsMemoryInformation

Static Protected Attributes

vtkProcessModuleProcessModule

Detailed Description

A class to encapaulate all of the process initialization, This super class assumes the application is running all in one process with no MPI.

Definition at line 48 of file vtkProcessModule.h.


Member Enumeration Documentation

enum vtkProcessModule::ServerFlags
 

These flags are used to specify destination servers for the SendStream function.

Enumeration values:
DATA_SERVER 
DATA_SERVER_ROOT 
RENDER_SERVER 
RENDER_SERVER_ROOT 
CLIENT 
CLIENT_AND_SERVERS 

Definition at line 55 of file vtkProcessModule.h.

enum vtkProcessModule::ProgressEventEnum
 

Enumeration values:
PROGRESS_EVENT_TAG 

Definition at line 66 of file vtkProcessModule.h.

enum vtkProcessModule::CommunicationIds
 

Enumeration values:
MultiDisplayDummy 
MultiDisplayRootRender 
MultiDisplaySatelliteRender 
MultiDisplayInfo 
PickBestProc 
PickBestDist2 
IceTWinInfo 
IceTNumTilesX 
IceTNumTilesY 
IceTTileRanks 
IceTRenInfo 
GlyphNPointsGather 
GlyphNPointsScatter 
TreeCompositeDataFlag 
TreeCompositeStatus 
DuplicatePDNProcs 
DuplicatePDNRecLen 
DuplicatePDNAllBuffers 
IntegrateAttrInfo 
IntegrateAttrData 
PickMakeGIDs 
TemporalPickHasData 
TemporalPicksData 

Definition at line 253 of file vtkProcessModule.h.


Constructor & Destructor Documentation

vtkProcessModule::vtkProcessModule  )  [protected]
 

vtkProcessModule::~vtkProcessModule  )  [protected]
 


Member Function Documentation

int vtkProcessModule::GetRootId int  serverId  )  [inline, static]
 

Definition at line 71 of file vtkProcessModule.h.

vtkProcessModule::vtkTypeRevisionMacro vtkProcessModule  ,
vtkObject 
 

void vtkProcessModule::PrintSelf ostream &  os,
vtkIndent  indent
 

Reimplemented in vtkPVClientServerModule, vtkPVMPIProcessModule, and vtkPVProcessModule.

vtkDataObject* vtkProcessModule::GetDataObjectOfType const char *  classname  ) 
 

Returns a data object of the given type. This is a utility method used to increase performance. The first time the data object of a given type is requested, it is instantiated and put in map. The following calls do not cause instantiation. Used while comparing data types for input matching.

virtual void vtkProcessModule::GatherInformation vtkPVInformation info,
vtkClientServerID  id
[virtual]
 

This is going to be a generic method of getting/gathering information form the server.

Reimplemented in vtkPVClientServerModule.

virtual void vtkProcessModule::GatherInformationRenderServer vtkPVInformation info,
vtkClientServerID  id
[virtual]
 

This is going to be a generic method of getting/gathering information form the server.

Reimplemented in vtkPVClientServerModule.

virtual void vtkProcessModule::GatherInformationInternal const char *  infoClassName,
vtkObject *  object
[virtual]
 

This is going to be a generic method of getting/gathering information form the server.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::Start int  ,
char ** 
[pure virtual]
 

Implemented in vtkPVClientServerModule, vtkPVMPIProcessModule, and vtkPVProcessModule.

virtual void vtkProcessModule::Exit  )  [pure virtual]
 

This breaks rmi loops and cleans up processes.`

Implemented in vtkPVClientServerModule, vtkPVMPIProcessModule, and vtkPVProcessModule.

vtkClientServerID vtkProcessModule::NewStreamObject const char *  ,
vtkClientServerStream &  stream
 

These methods append commands to the given vtkClientServerStream to construct or delete a vtk object. For construction, the type of the object is specified by string name and the new unique object id is returned. For deletion the object is specified by its id. These methods do not send the stream anywhere, so the caller must use SendStream() to actually perform the operation.

void vtkProcessModule::DeleteStreamObject vtkClientServerID  ,
vtkClientServerStream &  stream
 

These methods append commands to the given vtkClientServerStream to construct or delete a vtk object. For construction, the type of the object is specified by string name and the new unique object id is returned. For deletion the object is specified by its id. These methods do not send the stream anywhere, so the caller must use SendStream() to actually perform the operation.

virtual vtkObjectBase* vtkProcessModule::GetObjectFromID vtkClientServerID   )  [virtual]
 

Return the vtk object associated with the given id for the client. If the id is for an object on another node then 0 is returned.

Reimplemented in vtkPVProcessModule.

virtual const vtkClientServerStream& vtkProcessModule::GetLastResult vtkTypeUInt32  server  )  [virtual]
 

Return the last result for the specified server. In this case, the server should be exactly one of the ServerFlags, and not a combination of servers. For an MPI server the result from the root node is returned. There is no connection to the individual nodes of a server.

int vtkProcessModule::SendStream vtkTypeUInt32  server,
vtkClientServerStream &  stream,
int  resetStream = 1
 

Send a vtkClientServerStream to the specified servers. Servers are specified with a bit vector. To send to more than one server use the bitwise or operator to combine servers. The resetStream flag determines if Reset is called to clear the stream after it is sent.

virtual vtkClientServerInterpreter* vtkProcessModule::GetInterpreter  )  [virtual]
 

Get the interpreter used on the local process.

virtual void vtkProcessModule::InitializeInterpreter  )  [virtual]
 

Initialize/Finalize the process module's vtkClientServerInterpreter.

Reimplemented in vtkPVProcessModule.

virtual void vtkProcessModule::FinalizeInterpreter  )  [virtual]
 

Initialize/Finalize the process module's vtkClientServerInterpreter.

Reimplemented in vtkPVProcessModule.

void vtkProcessModule::Initialize  ) 
 

Initialize and finalize process module.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

void vtkProcessModule::Finalize  ) 
 

Initialize and finalize process module.

virtual int vtkProcessModule::GetReportInterpreterErrors  )  [virtual]
 

Set/Get whether to report errors from the Interpreter.

virtual void vtkProcessModule::SetReportInterpreterErrors int   )  [virtual]
 

Set/Get whether to report errors from the Interpreter.

virtual void vtkProcessModule::ReportInterpreterErrorsOn  )  [virtual]
 

Set/Get whether to report errors from the Interpreter.

virtual void vtkProcessModule::ReportInterpreterErrorsOff  )  [virtual]
 

Set/Get whether to report errors from the Interpreter.

virtual vtkMultiProcessController* vtkProcessModule::GetController  )  [virtual]
 

The controller is needed for filter that communicate internally.

virtual int vtkProcessModule::GetPartitionId  )  [inline, virtual]
 

Get the partition piece. -1 means no assigned piece.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

Definition at line 189 of file vtkProcessModule.h.

virtual int vtkProcessModule::GetNumberOfPartitions  )  [inline, virtual]
 

Get the number of processes participating in sharing the data.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

Definition at line 192 of file vtkProcessModule.h.

vtkClientServerID vtkProcessModule::GetUniqueID  ) 
 

vtkClientServerID vtkProcessModule::GetProcessModuleID  ) 
 

vtkProcessModule* vtkProcessModule::GetProcessModule  )  [static]
 

void vtkProcessModule::SetProcessModule vtkProcessModule pm  )  [static]
 

void vtkProcessModule::RegisterProgressEvent vtkObject *  po,
int  id
 

Register object with progress handler.

virtual void vtkProcessModule::SendPrepareProgress  )  [virtual]
 

Reimplemented in vtkPVProcessModule.

virtual void vtkProcessModule::SendCleanupPendingProgress  )  [virtual]
 

Reimplemented in vtkPVProcessModule.

void vtkProcessModule::PrepareProgress  ) 
 

This method is called before progress reports start comming.

void vtkProcessModule::CleanupPendingProgress  ) 
 

This method is called after force update to clenaup all the pending progresses.

void vtkProcessModule::ExecuteEvent vtkObject *  o,
unsigned long  event,
void *  calldata
 

Execute event on callback

vtkCommand* vtkProcessModule::GetObserver  ) 
 

Get the observer.

virtual void vtkProcessModule::SetLocalProgress const char *  filter,
int  progress
[pure virtual]
 

Set the local progress. Subclass should overwrite it.

Implemented in vtkPVProcessModule.

virtual int vtkProcessModule::GetProgressRequests  )  [virtual]
 

Set the local progress. Subclass should overwrite it.

virtual void vtkProcessModule::SetProgressRequests int   )  [virtual]
 

Set the local progress. Subclass should overwrite it.

virtual vtkPVProgressHandler* vtkProcessModule::GetProgressHandler  )  [virtual]
 

Set the local progress. Subclass should overwrite it.

virtual void vtkProcessModule::SetProgressEnabled int   )  [virtual]
 

virtual int vtkProcessModule::GetProgressEnabled  )  [virtual]
 

virtual vtkPVOptions* vtkProcessModule::GetOptions  )  [virtual]
 

Set and get the application options

virtual void vtkProcessModule::SetOptions vtkPVOptions op  )  [virtual]
 

Set and get the application options

void vtkProcessModule::SetGUIHelper vtkProcessModuleGUIHelper  ) 
 

Set the gui helper

ofstream* vtkProcessModule::GetLogFile  ) 
 

Get a pointer to the log file.

virtual void vtkProcessModule::CreateLogFile  )  [virtual]
 

virtual vtkTypeUInt32 vtkProcessModule::CreateSendFlag vtkTypeUInt32  servers  )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::SendStreamToClient vtkClientServerStream &   )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::SendStreamToDataServer vtkClientServerStream &   )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::SendStreamToDataServerRoot vtkClientServerStream &   )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::SendStreamToRenderServer vtkClientServerStream &   )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual int vtkProcessModule::SendStreamToRenderServerRoot vtkClientServerStream &   )  [protected, virtual]
 

Given the servers that need to receive the stream, create a flag that will send it to the correct places for this process module and make sure it only gets sent to each server once.

Reimplemented in vtkPVClientServerModule, and vtkPVMPIProcessModule.

virtual const vtkClientServerStream& vtkProcessModule::GetLastDataServerResult  )  [protected, virtual]
 

Get the last result from the DataServer, RenderServer or Client. If these are MPI processes, only the root last result is returned.

Reimplemented in vtkPVClientServerModule.

virtual const vtkClientServerStream& vtkProcessModule::GetLastRenderServerResult  )  [protected, virtual]
 

Get the last result from the DataServer, RenderServer or Client. If these are MPI processes, only the root last result is returned.

Reimplemented in vtkPVClientServerModule.

virtual const vtkClientServerStream& vtkProcessModule::GetLastClientResult  )  [protected, virtual]
 

Get the last result from the DataServer, RenderServer or Client. If these are MPI processes, only the root last result is returned.

void vtkProcessModule::InterpreterCallbackFunction vtkObject *  caller,
unsigned long  eid,
void *  cd,
void *  d
[static, protected]
 

virtual void vtkProcessModule::InterpreterCallback unsigned long  eid,
void * 
[protected, virtual]
 

virtual const char* vtkProcessModule::DetermineLogFilePrefix  )  [inline, protected, virtual]
 

Reimplemented in vtkPVClientServerModule.

Definition at line 316 of file vtkProcessModule.h.

void vtkProcessModule::ProgressEvent vtkObject *  o,
int  val,
const char *  filter
[protected]
 


Member Data Documentation

vtkMultiProcessController* vtkProcessModule::Controller [protected]
 

Definition at line 318 of file vtkProcessModule.h.

vtkPVInformation* vtkProcessModule::TemporaryInformation [protected]
 

Definition at line 319 of file vtkProcessModule.h.

vtkClientServerInterpreter* vtkProcessModule::Interpreter [protected]
 

Definition at line 321 of file vtkProcessModule.h.

vtkClientServerStream* vtkProcessModule::ClientServerStream [protected]
 

Definition at line 322 of file vtkProcessModule.h.

vtkClientServerID vtkProcessModule::UniqueID [protected]
 

Definition at line 323 of file vtkProcessModule.h.

vtkCallbackCommand* vtkProcessModule::InterpreterObserver [protected]
 

Definition at line 324 of file vtkProcessModule.h.

int vtkProcessModule::ReportInterpreterErrors [protected]
 

Definition at line 325 of file vtkProcessModule.h.

vtkProcessModule* vtkProcessModule::ProcessModule [static, protected]
 

Definition at line 327 of file vtkProcessModule.h.

vtkProcessModuleInternals* vtkProcessModule::Internals [protected]
 

Reimplemented in vtkPVProcessModule.

Definition at line 329 of file vtkProcessModule.h.

vtkPVProgressHandler* vtkProcessModule::ProgressHandler [protected]
 

Definition at line 333 of file vtkProcessModule.h.

int vtkProcessModule::ProgressRequests [protected]
 

Definition at line 334 of file vtkProcessModule.h.

int vtkProcessModule::ProgressEnabled [protected]
 

Definition at line 335 of file vtkProcessModule.h.

vtkProcessModuleObserver* vtkProcessModule::Observer [protected]
 

Definition at line 337 of file vtkProcessModule.h.

vtkPVOptions* vtkProcessModule::Options [protected]
 

Definition at line 338 of file vtkProcessModule.h.

vtkProcessModuleGUIHelper* vtkProcessModule::GUIHelper [protected]
 

Definition at line 339 of file vtkProcessModule.h.

ofstream* vtkProcessModule::LogFile [protected]
 

Definition at line 340 of file vtkProcessModule.h.

vtkKWProcessStatistics* vtkProcessModule::MemoryInformation [protected]
 

Definition at line 342 of file vtkProcessModule.h.


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:41:49 2006 for ParaView by doxygen 1.3.5