ParaView
|
Read a file wrapping many other XML files. More...
#include <vtkXMLCollectionReader.h>
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 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 |
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.
typedef vtkXMLReader vtkXMLCollectionReader::Superclass |
Definition at line 41 of file vtkXMLCollectionReader.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented in vtkPVDReader.
|
static |
|
virtual |
Reimplemented in vtkPVDReader.
|
static |
void vtkXMLCollectionReader::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
protected |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protected |
|
protectedvirtual |
Reimplemented in vtkPVDReader.
|
protectedvirtual |
|
protectedvirtual |
|
protected |
|
protected |
|
staticprotected |
|
protectedvirtual |
|
protected |
|
protectedvirtual |
|
protected |
|
protected |
Definition at line 135 of file vtkXMLCollectionReader.h.
|
protected |
Definition at line 136 of file vtkXMLCollectionReader.h.
|
protected |
Definition at line 166 of file vtkXMLCollectionReader.h.
|
protected |
Definition at line 169 of file vtkXMLCollectionReader.h.