Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkXMLCollectionReader Class Reference

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

#include <vtkXMLCollectionReader.h>

Inheritance diagram for vtkXMLCollectionReader:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkXMLCollectionReader, vtkXMLReader)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetNumberOfOutputs ()
virtual vtkDataSet * GetOutput (int index)
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)

Static Public Member Functions

vtkXMLCollectionReader * New ()

Protected Member Functions

 vtkXMLCollectionReader ()
 ~vtkXMLCollectionReader ()
virtual const char * GetDataSetName ()
virtual void MarkGeneratedOutputs (vtkDataObject *output)
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
virtual void SetupEmptyOutput ()
virtual int FillOutputPortInformation (int, vtkInformation *info)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void SetupOutput (const char *filePath, int index, vtkInformation *outInfo)
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void ReadXMLData ()
virtual void InternalProgressCallback ()
void AddAttributeNameValue (const char *name, const char *value)

Static Protected Member Functions

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

Protected Attributes

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

vtkXMLCollectionReader* vtkXMLCollectionReader::New (   )  [static]
 

Reimplemented in vtkPVDReader.

vtkXMLCollectionReader::vtkTypeRevisionMacro (  vtkXMLCollectionReader  ,
vtkXMLReader 
) 
 

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

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.

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.

virtual int vtkXMLCollectionReader::GetNumberOfOutputs (   )  [virtual]
 

Get the number of outputs. Valid when a FileName has been set.

virtual vtkDataSet* vtkXMLCollectionReader::GetOutput (  int  index  )  [virtual]
 

Get the output with the given index. Valid when a FileName has been set. May change when Restriction settings are changed.

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 const char* vtkXMLCollectionReader::GetDataSetName (   )  [protected, virtual]
 

virtual void vtkXMLCollectionReader::MarkGeneratedOutputs (  vtkDataObject *  output  )  [protected, virtual]
 

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

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

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

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

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

void vtkXMLCollectionReader::SetupOutput (  const char *  filePath,
int  index,
vtkInformation *  outInfo
)  [protected]
 

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

void vtkXMLCollectionReader::ReadXMLData (   )  [protected]
 

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]
 

Member Data Documentation

vtkCallbackCommand* vtkXMLCollectionReader::InternalProgressObserver [protected]
 

Definition at line 141 of file vtkXMLCollectionReader.h.

vtkXMLCollectionReaderInternals* vtkXMLCollectionReader::Internal [protected]
 

Definition at line 144 of file vtkXMLCollectionReader.h.

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:48:30 2006 for ParaView by doxygen 1.3.5