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

Read a file wrapping many other XML files. More...

#include <vtkXMLCollectionReader.h>

Inheritance diagram for vtkXMLCollectionReader:
Inheritance graph
[legend]

Public Types

typedef vtkXMLReader Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
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 vtkXMLCollectionReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkXMLCollectionReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 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 RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
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)
 

Static Protected Member Functions

static void InternalProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 

Protected Attributes

bool InternalForceMultiBlock
 
int ForceOutputTypeToMultiBlock
 
vtkCallbackCommand * InternalProgressObserver
 
vtkXMLCollectionReaderInternals * Internal
 

Detailed Description

Read a file wrapping many other XML files.

vtkXMLCollectionReader will read a "Collection" VTKData XML file. This file format references an arbitrary number of other XML data sets. Each referenced data set has a list of associated attribute/value pairs. One may use the SetRestriction method to set requirements on attribute's values. Only those data sets in the file matching the restrictions will be read. Each matching data set becomes an output of this reader in the order in which they appear in the file.

Definition at line 37 of file vtkXMLCollectionReader.h.

Member Typedef Documentation

§ Superclass

typedef vtkXMLReader vtkXMLCollectionReader::Superclass

Definition at line 41 of file vtkXMLCollectionReader.h.

Constructor & Destructor Documentation

§ vtkXMLCollectionReader()

vtkXMLCollectionReader::vtkXMLCollectionReader ( )
protected

§ ~vtkXMLCollectionReader()

vtkXMLCollectionReader::~vtkXMLCollectionReader ( )
protected

Member Function Documentation

§ New()

static vtkXMLCollectionReader* vtkXMLCollectionReader::New ( )
static

§ GetClassName()

virtual const char* vtkXMLCollectionReader::GetClassName ( )
virtual

Reimplemented in vtkPVDReader.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented in vtkPVDReader.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetRestriction()

virtual void vtkXMLCollectionReader::SetRestriction ( const char *  name,
const char *  value 
)
virtual

Get/Set the required value for a particular named attribute.

Only data sets matching this value will be read. A NULL value or empty string will disable any restriction from the given attribute.

§ GetRestriction()

virtual const char* vtkXMLCollectionReader::GetRestriction ( const char *  name)
virtual

Get/Set the required value for a particular named attribute.

Only data sets matching this value will be read. A NULL value or empty string will disable any restriction from the given attribute.

§ SetRestrictionAsIndex()

virtual void vtkXMLCollectionReader::SetRestrictionAsIndex ( const char *  name,
int  index 
)
virtual

Get/set the required value for a particular named 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. Make sure to call UpdateInformation() before using these methods.

§ GetRestrictionAsIndex()

virtual int vtkXMLCollectionReader::GetRestrictionAsIndex ( const char *  name)
virtual

Get/set the required value for a particular named 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. Make sure to call UpdateInformation() before using these methods.

§ GetNumberOfAttributes()

int vtkXMLCollectionReader::GetNumberOfAttributes ( )

Get the number of distinct attribute values present in the file.

Valid after UpdateInformation.

§ GetAttributeName()

const char* vtkXMLCollectionReader::GetAttributeName ( int  attribute)

Get the name of an attribute.

The order of attributes with respect to the index is not specified, but will be the same every time the same instance of the reader reads the same input file.

§ GetAttributeIndex()

int vtkXMLCollectionReader::GetAttributeIndex ( const char *  name)

Get the index of the attribute with the given name.

Returns -1 if no such attribute exists.

§ GetNumberOfAttributeValues()

int vtkXMLCollectionReader::GetNumberOfAttributeValues ( int  attribute)

Get the number of distinct values for the given attribute.

§ GetAttributeValue() [1/2]

const char* vtkXMLCollectionReader::GetAttributeValue ( int  attribute,
int  index 
)

Get one of the possible values for a given attribute.

The order of values for the attribute with respect to the index is not specified, but will be the same every time the same instance of the reader reads the same input file.

§ GetAttributeValue() [2/2]

const char* vtkXMLCollectionReader::GetAttributeValue ( const char *  name,
int  index 
)

Get one of the possible values for a given attribute.

The order of values for the attribute with respect to the index is not specified, but will be the same every time the same instance of the reader reads the same input file.

§ GetAttributeValueIndex() [1/2]

int vtkXMLCollectionReader::GetAttributeValueIndex ( int  attribute,
const char *  value 
)

Get the index of the attribute value with the given name.

Returns -1 if no such attribute or value exists.

§ GetAttributeValueIndex() [2/2]

int vtkXMLCollectionReader::GetAttributeValueIndex ( const char *  name,
const char *  value 
)

Get the index of the attribute value with the given name.

Returns -1 if no such attribute or value exists.

§ GetOutputXMLDataElement()

vtkXMLDataElement* vtkXMLCollectionReader::GetOutputXMLDataElement ( int  index)

Get the vtkXMLDataElement representing the collection element corresponding to the output with the given index.

Valid when a FileName has been set. May change when Restriction settings are changed.

§ SetForceOutputTypeToMultiBlock()

virtual void vtkXMLCollectionReader::SetForceOutputTypeToMultiBlock ( int  )
virtual

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.

§ GetForceOutputTypeToMultiBlock()

virtual int vtkXMLCollectionReader::GetForceOutputTypeToMultiBlock ( )
virtual

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.

§ ForceOutputTypeToMultiBlockOn()

virtual void vtkXMLCollectionReader::ForceOutputTypeToMultiBlockOn ( )
virtual

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.

§ ForceOutputTypeToMultiBlockOff()

virtual void vtkXMLCollectionReader::ForceOutputTypeToMultiBlockOff ( )
virtual

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.

§ BuildRestrictedDataSets()

void vtkXMLCollectionReader::BuildRestrictedDataSets ( )
protected

§ GetDataSetName()

virtual const char* vtkXMLCollectionReader::GetDataSetName ( )
protectedvirtual

§ ReadPrimaryElement()

virtual int vtkXMLCollectionReader::ReadPrimaryElement ( vtkXMLDataElement *  ePrimary)
protectedvirtual

§ FillOutputPortInformation()

virtual int vtkXMLCollectionReader::FillOutputPortInformation ( int  ,
vtkInformation *  info 
)
protectedvirtual

§ SetupOutput()

vtkDataObject* vtkXMLCollectionReader::SetupOutput ( const char *  filePath,
int  index 
)
protected

§ RequestDataObject()

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

Reimplemented in vtkPVDReader.

§ RequestInformation()

virtual int vtkXMLCollectionReader::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

§ SetupEmptyOutput()

virtual void vtkXMLCollectionReader::SetupEmptyOutput ( )
protectedvirtual

§ ReadXMLData()

void vtkXMLCollectionReader::ReadXMLData ( )
protected

§ ReadXMLDataImpl()

void vtkXMLCollectionReader::ReadXMLDataImpl ( )
protected

§ InternalProgressCallbackFunction()

static void vtkXMLCollectionReader::InternalProgressCallbackFunction ( vtkObject *  ,
unsigned  long,
void *  ,
void *   
)
staticprotected

§ InternalProgressCallback()

virtual void vtkXMLCollectionReader::InternalProgressCallback ( )
protectedvirtual

§ AddAttributeNameValue()

void vtkXMLCollectionReader::AddAttributeNameValue ( const char *  name,
const char *  value 
)
protected

§ SetRestrictionImpl()

virtual void vtkXMLCollectionReader::SetRestrictionImpl ( const char *  name,
const char *  value,
bool  doModify 
)
protectedvirtual

§ ReadAFile()

void vtkXMLCollectionReader::ReadAFile ( int  index,
int  updatePiece,
int  updateNumPieces,
int  updateGhostLevels,
vtkDataObject *  actualOutput 
)
protected

Member Data Documentation

§ InternalForceMultiBlock

bool vtkXMLCollectionReader::InternalForceMultiBlock
protected

Definition at line 135 of file vtkXMLCollectionReader.h.

§ ForceOutputTypeToMultiBlock

int vtkXMLCollectionReader::ForceOutputTypeToMultiBlock
protected

Definition at line 136 of file vtkXMLCollectionReader.h.

§ InternalProgressObserver

vtkCallbackCommand* vtkXMLCollectionReader::InternalProgressObserver
protected

Definition at line 166 of file vtkXMLCollectionReader.h.

§ Internal

vtkXMLCollectionReaderInternals* vtkXMLCollectionReader::Internal
protected

Definition at line 169 of file vtkXMLCollectionReader.h.


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