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

ParaView-specific vtkXMLCollectionReader subclass. More...

#include <vtkPVDReader.h>

Inheritance diagram for vtkPVDReader:
Inheritance graph
[legend]
Collaboration diagram for vtkPVDReader:
Collaboration graph
[legend]

Public Types

typedef vtkXMLCollectionReader Superclass
 
- Public Types inherited from vtkXMLCollectionReader
typedef vtkXMLReader Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetTimeStep (int index)
 Get/Set the required value for the timestep attribute. More...
 
int GetTimeStep ()
 Get/Set the required value for the timestep attribute. More...
 
virtual int * GetTimeStepRange ()
 Get the range of index values valid for the TimestepAsIndex setting. More...
 
virtual void GetTimeStepRange (int &, int &)
 Get the range of index values valid for the TimestepAsIndex setting. More...
 
virtual void GetTimeStepRange (int [2])
 Get the range of index values valid for the TimestepAsIndex setting. More...
 
- Public Member Functions inherited from vtkXMLCollectionReader
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfAttributes ()
 Get the number of distinct attribute values present in the file. More...
 
const char * GetAttributeName (int attribute)
 Get the name of an attribute. More...
 
int GetAttributeIndex (const char *name)
 Get the index of the attribute with the given name. More...
 
int GetNumberOfAttributeValues (int attribute)
 Get the number of distinct values for the given attribute. More...
 
vtkXMLDataElement * GetOutputXMLDataElement (int index)
 Get the vtkXMLDataElement representing the collection element corresponding to the output with the given index. More...
 
virtual void SetRestriction (const char *name, const char *value)
 Get/Set the required value for a particular named attribute. More...
 
virtual const char * GetRestriction (const char *name)
 Get/Set the required value for a particular named attribute. More...
 
virtual void SetRestrictionAsIndex (const char *name, int index)
 Get/set the required value for a particular named attribute. More...
 
virtual int GetRestrictionAsIndex (const char *name)
 Get/set the required value for a particular named attribute. More...
 
const char * GetAttributeValue (int attribute, int index)
 Get one of the possible values for a given attribute. More...
 
const char * GetAttributeValue (const char *name, int index)
 Get one of the possible values for a given attribute. More...
 
int GetAttributeValueIndex (int attribute, const char *value)
 Get the index of the attribute value with the given name. More...
 
int GetAttributeValueIndex (const char *name, const char *value)
 Get the index of the attribute value with the given name. More...
 
virtual void SetForceOutputTypeToMultiBlock (int)
 If ForceOutputTypeToMultiBlock is set to 1, the output of this reader will always be a multi-block dataset, even if there is 1 simple output. More...
 
virtual int GetForceOutputTypeToMultiBlock ()
 If ForceOutputTypeToMultiBlock is set to 1, the output of this reader will always be a multi-block dataset, even if there is 1 simple output. More...
 
virtual void ForceOutputTypeToMultiBlockOn ()
 If ForceOutputTypeToMultiBlock is set to 1, the output of this reader will always be a multi-block dataset, even if there is 1 simple output. More...
 
virtual void ForceOutputTypeToMultiBlockOff ()
 If ForceOutputTypeToMultiBlock is set to 1, the output of this reader will always be a multi-block dataset, even if there is 1 simple output. More...
 

Static Public Member Functions

static vtkPVDReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVDReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkXMLCollectionReader
static vtkXMLCollectionReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkXMLCollectionReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVDReader ()
 
 ~vtkPVDReader ()
 
void ReadXMLData ()
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void SetupOutputInformation (vtkInformation *outInfo)
 
- Protected Member Functions inherited from vtkXMLCollectionReader
 vtkXMLCollectionReader ()
 
 ~vtkXMLCollectionReader ()
 
void BuildRestrictedDataSets ()
 
virtual const char * GetDataSetName ()
 
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
 
virtual int FillOutputPortInformation (int, vtkInformation *info)
 
vtkDataObject * SetupOutput (const char *filePath, int index)
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void SetupEmptyOutput ()
 
void ReadXMLData ()
 
void ReadXMLDataImpl ()
 
virtual void InternalProgressCallback ()
 
void AddAttributeNameValue (const char *name, const char *value)
 
virtual void SetRestrictionImpl (const char *name, const char *value, bool doModify)
 
void ReadAFile (int index, int updatePiece, int updateNumPieces, int updateGhostLevels, vtkDataObject *actualOutput)
 

Protected Attributes

int TimeStepRange [2]
 
- Protected Attributes inherited from vtkXMLCollectionReader
bool InternalForceMultiBlock
 
int ForceOutputTypeToMultiBlock
 
vtkCallbackCommand * InternalProgressObserver
 
vtkXMLCollectionReaderInternals * Internal
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkXMLCollectionReader
static void InternalProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 

Detailed Description

ParaView-specific vtkXMLCollectionReader subclass.

vtkPVDReader subclasses vtkXMLCollectionReader to add ParaView-specific methods.

Definition at line 29 of file vtkPVDReader.h.

Member Typedef Documentation

§ Superclass

Definition at line 33 of file vtkPVDReader.h.

Constructor & Destructor Documentation

§ vtkPVDReader()

vtkPVDReader::vtkPVDReader ( )
protected

§ ~vtkPVDReader()

vtkPVDReader::~vtkPVDReader ( )
protected

Member Function Documentation

§ New()

static vtkPVDReader* vtkPVDReader::New ( )
static

§ GetClassName()

virtual const char* vtkPVDReader::GetClassName ( )
virtual

Reimplemented from vtkXMLCollectionReader.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkXMLCollectionReader.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetTimeStep()

void vtkPVDReader::SetTimeStep ( int  index)

Get/Set the required value for the timestep attribute.

The value should be referenced by its index. Only data sets matching this value will be read. An out-of-range index will remove the restriction.

§ GetTimeStep()

int vtkPVDReader::GetTimeStep ( )

Get/Set the required value for the timestep attribute.

The value should be referenced by its index. Only data sets matching this value will be read. An out-of-range index will remove the restriction.

§ GetTimeStepRange() [1/3]

virtual int* vtkPVDReader::GetTimeStepRange ( )
virtual

Get the range of index values valid for the TimestepAsIndex setting.

§ GetTimeStepRange() [2/3]

virtual void vtkPVDReader::GetTimeStepRange ( int &  ,
int &   
)
virtual

Get the range of index values valid for the TimestepAsIndex setting.

§ GetTimeStepRange() [3/3]

virtual void vtkPVDReader::GetTimeStepRange ( int  [2])
virtual

Get the range of index values valid for the TimestepAsIndex setting.

§ ReadXMLData()

void vtkPVDReader::ReadXMLData ( )
protected

§ RequestDataObject()

virtual int vtkPVDReader::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Reimplemented from vtkXMLCollectionReader.

§ SetupOutputInformation()

virtual void vtkPVDReader::SetupOutputInformation ( vtkInformation *  outInfo)
protectedvirtual

Member Data Documentation

§ TimeStepRange

int vtkPVDReader::TimeStepRange[2]
protected

Definition at line 68 of file vtkPVDReader.h.


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