ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCPDataDescription Class Reference

This class provides the description of the data for the coprocessor pipelines. More...

#include <vtkCPDataDescription.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetTimeData (double time, vtkIdType timeStep)
 Set the time step and current simulation time. More...
 
virtual vtkIdType GetTimeStep ()
 Get the current time step that should be set in the adaptor. More...
 
virtual double GetTime ()
 Get the current time that should be set in the adaptor. More...
 
virtual void SetForceOutput (bool)
 Specify whether or not to force output of all coprocessing pipelines. More...
 
virtual void ForceOutputOn ()
 Specify whether or not to force output of all coprocessing pipelines. More...
 
virtual void ForceOutputOff ()
 
virtual bool GetForceOutput ()
 Return whether or not output is forced for all coprocessing pipelines. More...
 
void AddInput (const char *gridName)
 Add names for grids produced by the simulation. More...
 
unsigned int GetNumberOfInputDescriptions ()
 Returns the number of input descriptions. More...
 
void ResetInputDescriptions ()
 Reset the names of the fields that are needed, the required meshes, etc. More...
 
void ResetAll ()
 Reset the names of the fields that are needed, the required meshes, etc. More...
 
vtkCPInputDataDescriptionGetInputDescription (unsigned int)
 Provides access to a grid description using the index. More...
 
const char * GetInputDescriptionName (unsigned int)
 Provides the name for the input description at the given index. More...
 
vtkCPInputDataDescriptionGetInputDescriptionByName (const char *)
 Provides access to a grid description using the grid name. More...
 
bool GetIfGridIsNecessary (const char *)
 Returns true if the grid is necessary, given the grid's name. More...
 
bool GetIfAnyGridNecessary ()
 Returns true if any of the grids is necessary. More...
 
void SetUserData (vtkFieldData *UserData)
 Set user defined information that can be passed from the adaptor to the coprocessing pipelines. More...
 
virtual vtkFieldData * GetUserData ()
 Set user defined information that can be passed from the adaptor to the coprocessing pipelines. More...
 

Static Public Member Functions

static vtkCPDataDescriptionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCPDataDescriptionSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkCPDataDescription ()
 
virtual ~vtkCPDataDescription ()
 

Detailed Description

This class provides the description of the data for the coprocessor pipelines.

Definition at line 27 of file vtkCPDataDescription.h.

Member Typedef Documentation

§ Superclass

Definition at line 31 of file vtkCPDataDescription.h.

Constructor & Destructor Documentation

§ vtkCPDataDescription()

vtkCPDataDescription::vtkCPDataDescription ( )
protected

§ ~vtkCPDataDescription()

virtual vtkCPDataDescription::~vtkCPDataDescription ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkCPDataDescription* vtkCPDataDescription::New ( )
static

§ GetClassName()

virtual const char* vtkCPDataDescription::GetClassName ( )
virtual

§ IsTypeOf()

static int vtkCPDataDescription::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkCPDataDescription::IsA ( const char *  type)
virtual

§ SafeDownCast()

static vtkCPDataDescription* vtkCPDataDescription::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

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

§ SetTimeData()

void vtkCPDataDescription::SetTimeData ( double  time,
vtkIdType  timeStep 
)

Set the time step and current simulation time.

§ GetTimeStep()

virtual vtkIdType vtkCPDataDescription::GetTimeStep ( )
virtual

Get the current time step that should be set in the adaptor.

§ GetTime()

virtual double vtkCPDataDescription::GetTime ( )
virtual

Get the current time that should be set in the adaptor.

§ SetForceOutput()

virtual void vtkCPDataDescription::SetForceOutput ( bool  )
virtual

Specify whether or not to force output of all coprocessing pipelines.

This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.

§ ForceOutputOn()

virtual void vtkCPDataDescription::ForceOutputOn ( )
virtual

Specify whether or not to force output of all coprocessing pipelines.

This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.

§ ForceOutputOff()

virtual void vtkCPDataDescription::ForceOutputOff ( )
virtual

§ GetForceOutput()

virtual bool vtkCPDataDescription::GetForceOutput ( )
virtual

Return whether or not output is forced for all coprocessing pipelines.

§ AddInput()

void vtkCPDataDescription::AddInput ( const char *  gridName)

Add names for grids produced by the simulation.

This allocates a new vtkCPInputDataDescription for that grid, if a grid by that name does not already exist.

§ GetNumberOfInputDescriptions()

unsigned int vtkCPDataDescription::GetNumberOfInputDescriptions ( )

Returns the number of input descriptions.

§ ResetInputDescriptions()

void vtkCPDataDescription::ResetInputDescriptions ( )

Reset the names of the fields that are needed, the required meshes, etc.

that are stored in the vtkCPInputDescriptions.

§ ResetAll()

void vtkCPDataDescription::ResetAll ( )

Reset the names of the fields that are needed, the required meshes, etc.

that are stored in the vtkCPInputDescriptions as well as the time information and output forcing. Automatically called after vtkCPProcessor::CoProcess() is called.

§ GetInputDescription()

vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescription ( unsigned  int)

Provides access to a grid description using the index.

§ GetInputDescriptionName()

const char* vtkCPDataDescription::GetInputDescriptionName ( unsigned  int)

Provides the name for the input description at the given index.

§ GetInputDescriptionByName()

vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescriptionByName ( const char *  )

Provides access to a grid description using the grid name.

§ GetIfGridIsNecessary()

bool vtkCPDataDescription::GetIfGridIsNecessary ( const char *  )

Returns true if the grid is necessary, given the grid's name.

§ GetIfAnyGridNecessary()

bool vtkCPDataDescription::GetIfAnyGridNecessary ( )

Returns true if any of the grids is necessary.

§ SetUserData()

void vtkCPDataDescription::SetUserData ( vtkFieldData *  UserData)

Set user defined information that can be passed from the adaptor to the coprocessing pipelines.

§ GetUserData()

virtual vtkFieldData* vtkCPDataDescription::GetUserData ( )
virtual

Set user defined information that can be passed from the adaptor to the coprocessing pipelines.


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