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

#include <vtkXMLCollectionReader.h>

Inheritance diagram for vtkXMLCollectionReader:

Collaboration diagram for vtkXMLCollectionReader:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetNumberOfAttributes ()
const char *	GetAttributeName (int attribute)
int	GetAttributeIndex (const char *name)
int	GetNumberOfAttributeValues (int attribute)
vtkXMLDataElement *	GetOutputXMLDataElement (int index)

virtual void	SetRestriction (const char name, const char value)
virtual const char *	GetRestriction (const char *name)

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

const char *	GetAttributeValue (int attribute, int index)
const char *	GetAttributeValue (const char *name, int index)

int	GetAttributeValueIndex (int attribute, const char *value)
int	GetAttributeValueIndex (const char name, const char value)

virtual void	SetForceOutputTypeToMultiBlock (int)
virtual int	GetForceOutputTypeToMultiBlock ()
virtual void	ForceOutputTypeToMultiBlockOn ()
virtual void	ForceOutputTypeToMultiBlockOff ()
Static Public Member Functions
static vtkXMLCollectionReader *	New ()
static int	IsTypeOf (const char *type)
static vtkXMLCollectionReader *	SafeDownCast (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 35 of file vtkXMLCollectionReader.h.

Constructor & Destructor Documentation

vtkXMLCollectionReader::vtkXMLCollectionReader ( ) [protected]

vtkXMLCollectionReader::~vtkXMLCollectionReader ( ) [protected]

Member Function Documentation

static vtkXMLCollectionReader* vtkXMLCollectionReader::New ( ) [static]

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

virtual const char* vtkXMLCollectionReader::GetClassName ( ) [virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

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

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

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

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

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

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

void vtkXMLCollectionReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

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.

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.

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.

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.

int vtkXMLCollectionReader::GetNumberOfAttributes ( )

Get the number of distinct attribute values present in the file. Valid after UpdateInformation.

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.

int vtkXMLCollectionReader::GetAttributeIndex ( const char * name )

Get the index of the attribute with the given name. Returns -1 if no such attribute exists.

int vtkXMLCollectionReader::GetNumberOfAttributeValues ( int attribute )

Get the number of distinct values for the given attribute.

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.

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.

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.

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.

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.

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.

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.

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.

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.

void vtkXMLCollectionReader::BuildRestrictedDataSets ( ) [protected]

virtual const char* vtkXMLCollectionReader::GetDataSetName ( ) [protected, virtual]

Implements vtkXMLReader.

virtual int vtkXMLCollectionReader::ReadPrimaryElement ( vtkXMLDataElement * ePrimary ) [protected, virtual]

Reimplemented from vtkXMLReader.

virtual int vtkXMLCollectionReader::FillOutputPortInformation	(	int	,
		vtkInformation *	info
	)		`[protected, virtual]`

Reimplemented from vtkXMLReader.

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

virtual int vtkXMLCollectionReader::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`

Reimplemented in vtkPVDReader.

virtual int vtkXMLCollectionReader::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`

Reimplemented from vtkXMLReader.

virtual void vtkXMLCollectionReader::SetupEmptyOutput ( ) [protected, virtual]

Implements vtkXMLReader.

void vtkXMLCollectionReader::ReadXMLData ( ) [protected, virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkPVDReader.

void vtkXMLCollectionReader::ReadXMLDataImpl ( ) [protected]

static void vtkXMLCollectionReader::InternalProgressCallbackFunction	(	vtkObject *	,
		unsigned	long,
		void *	,
		void *
	)		`[static, protected]`

virtual void vtkXMLCollectionReader::InternalProgressCallback ( ) [protected, virtual]

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

virtual void vtkXMLCollectionReader::SetRestrictionImpl	(	const char *	name,
		const char *	value,
		bool	doModify
	)		`[protected, virtual]`

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