vtkPVSummaryHelper Class Reference

Synchronize writing of summary files. More...

#include <vtkPVSummaryHelper.h>

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVSummaryHelper, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
int	SynchronizeSummaryFiles ()
virtual void	SetController (vtkMultiProcessController *)
virtual vtkMultiProcessController *	GetController ()
virtual void	SetWriter (vtkXMLWriter *)
virtual vtkXMLWriter *	GetWriter ()
Static Public Member Functions
vtkPVSummaryHelper *	New ()
Protected Member Functions
	vtkPVSummaryHelper ()
	~vtkPVSummaryHelper ()
int	CheckDummyFile ()
void	DeleteDummyFiles ()
void	SetWriteSummaryFile (int value)
Protected Attributes
vtkMultiProcessController *	Controller
vtkXMLWriter *	Writer

---

Detailed Description

Synchronize writing of summary files.

When a parallel XML file is written, we must make sure every disk will have exactly one process write the summary file. This helper class is used by PV writer modules to set the WriteSummaryFile or WriteCollectionFile flags correctly on the writer.

Definition at line 32 of file vtkPVSummaryHelper.h.

---

Constructor & Destructor Documentation

vtkPVSummaryHelper::vtkPVSummaryHelper (   )  [protected]

vtkPVSummaryHelper::~vtkPVSummaryHelper (   )  [protected]

---

Member Function Documentation

vtkPVSummaryHelper* vtkPVSummaryHelper::New (   )  [static]

vtkPVSummaryHelper::vtkTypeRevisionMacro (  vtkPVSummaryHelper  , vtkObject  )

void vtkPVSummaryHelper::PrintSelf (  ostream &  os, vtkIndent  indent )

virtual void vtkPVSummaryHelper::SetController (  vtkMultiProcessController *   )  [virtual]

This class uses MPI communication mechanisms to verify the integrity of all case files in the master file. The get method interface must use vtkMultiProcessController instead of vtkMPIController because Tcl wrapping requires the class's wrapper to be defined, but it is not defined if MPI is not on. In client-server mode, we may still need to create an instance of this class on the client process even if MPI is not compiled in.

virtual vtkMultiProcessController* vtkPVSummaryHelper::GetController (   )  [virtual]

This class uses MPI communication mechanisms to verify the integrity of all case files in the master file. The get method interface must use vtkMultiProcessController instead of vtkMPIController because Tcl wrapping requires the class's wrapper to be defined, but it is not defined if MPI is not on. In client-server mode, we may still need to create an instance of this class on the client process even if MPI is not compiled in.

virtual void vtkPVSummaryHelper::SetWriter (  vtkXMLWriter *   )  [virtual]

Get/Set the writer instance to be configured.

virtual vtkXMLWriter* vtkPVSummaryHelper::GetWriter (   )  [virtual]

Get/Set the writer instance to be configured.

int vtkPVSummaryHelper::SynchronizeSummaryFiles (   )

Synchronize writing of summary files across multiple processes according to the sharing of disks. Only one process will write the summary file to each disk. Return value on process 0 is 1 for success and 0 for failure. Return value on other processes is not meaningful. Failure can occur if the directory is not writable on all processes' disks.

int vtkPVSummaryHelper::CheckDummyFile (   )  [protected]

void vtkPVSummaryHelper::DeleteDummyFiles (   )  [protected]

void vtkPVSummaryHelper::SetWriteSummaryFile (  int  value  )  [protected]

---

Member Data Documentation

vtkMultiProcessController* vtkPVSummaryHelper::Controller [protected]

Definition at line 71 of file vtkPVSummaryHelper.h.

vtkXMLWriter* vtkPVSummaryHelper::Writer [protected]

Definition at line 73 of file vtkPVSummaryHelper.h.

---

The documentation for this class was generated from the following file:

• Servers/Filters/vtkPVSummaryHelper.h

---