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

#include <vtkXMLCollectionReader.h>

Inheritance diagram for vtkXMLCollectionReader:

[legend]

Collaboration diagram for vtkXMLCollectionReader:

[legend]

Public Types
typedef vtkXMLReader	Superclass

Public Types inherited from vtkXMLReader
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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...

Public Member Functions inherited from vtkXMLReader
vtkXMLReader *	NewInstance () const

virtual int	CanReadFile (const char *name)

virtual void	CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))

virtual int	GetNumberOfTimeSteps ()

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

virtual void	SetReadFromInputString (int)

virtual int	GetReadFromInputString ()

virtual void	ReadFromInputStringOn ()

virtual void	ReadFromInputStringOff ()

void	SetInputString (std::string s)

vtkDataSet *	GetOutputAsDataSet ()

vtkDataSet *	GetOutputAsDataSet (int index)

virtual vtkDataArraySelection *	GetPointDataArraySelection ()

virtual vtkDataArraySelection *	GetCellDataArraySelection ()

int	GetNumberOfPointArrays ()

int	GetNumberOfCellArrays ()

const char *	GetPointArrayName (int index)

const char *	GetCellArrayName (int index)

int	GetPointArrayStatus (const char *name)

int	GetCellArrayStatus (const char *name)

void	SetPointArrayStatus (const char *name, int status)

void	SetCellArrayStatus (const char *name, int status)

virtual void	SetTimeStep (int)

virtual int	GetTimeStep ()

virtual int *	GetTimeStepRange ()

virtual void	GetTimeStepRange (int &, int &)

virtual void	GetTimeStepRange (int[2])

virtual void	SetTimeStepRange (int, int)

void	SetTimeStepRange (int[2])

vtkXMLDataParser *	GetXMLParser ()

void	SetReaderErrorObserver (vtkCommand *)

virtual vtkCommand *	GetReaderErrorObserver ()

void	SetParserErrorObserver (vtkCommand *)

virtual vtkCommand *	GetParserErrorObserver ()

virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

virtual void	SetReadFromInputString (int)

virtual int	GetReadFromInputString ()

virtual void	ReadFromInputStringOn ()

virtual void	ReadFromInputStringOff ()

void	SetInputString (std::string s)

vtkDataSet *	GetOutputAsDataSet ()

vtkDataSet *	GetOutputAsDataSet (int index)

virtual vtkDataArraySelection *	GetPointDataArraySelection ()

virtual vtkDataArraySelection *	GetCellDataArraySelection ()

int	GetNumberOfPointArrays ()

int	GetNumberOfCellArrays ()

const char *	GetPointArrayName (int index)

const char *	GetCellArrayName (int index)

int	GetPointArrayStatus (const char *name)

int	GetCellArrayStatus (const char *name)

void	SetPointArrayStatus (const char *name, int status)

void	SetCellArrayStatus (const char *name, int status)

virtual void	SetTimeStep (int)

virtual int	GetTimeStep ()

virtual int *	GetTimeStepRange ()

virtual void	GetTimeStepRange (int &, int &)

virtual void	GetTimeStepRange (int[2])

virtual void	SetTimeStepRange (int, int)

void	SetTimeStepRange (int[2])

vtkXMLDataParser *	GetXMLParser ()

void	SetReaderErrorObserver (vtkCommand *)

virtual vtkCommand *	GetReaderErrorObserver ()

void	SetParserErrorObserver (vtkCommand *)

virtual vtkCommand *	GetParserErrorObserver ()

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

void	SetUpdateExtent (int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkXMLCollectionReader *	New ()

static int	IsTypeOf (const char *type)

static vtkXMLCollectionReader *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkXMLReader
static int	IsTypeOf (const char *type)

static vtkXMLReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkXMLCollectionReader ()

	~vtkXMLCollectionReader () override

void	BuildRestrictedDataSets ()

const char *	GetDataSetName () override

int	ReadPrimaryElement (vtkXMLDataElement *ePrimary) override

int	FillOutputPortInformation (int, vtkInformation *info) override

vtkDataObject *	SetupOutput (const std::string &filePath, int index)

vtkXMLReader *	SetupReader (const std::string &filePath, int index)
	Ensures that an appropriate reader is setup for the specified index. More...

int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

void	SetupEmptyOutput () override

void	ReadXMLData () override

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)

void	FillArraySelectionUsingReaders (const std::string &filePath)
	iterating over all readers (which corresponds to number of distinct datasets in the file, and not distinct timesteps), populate this->*ArraySelection objects. More...

Protected Member Functions inherited from vtkXMLReader
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLReader ()

	~vtkXMLReader ()

virtual int	ReadXMLInformation ()

virtual int	CanReadFileVersion (int major, int minor)

virtual void	SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))

virtual void	SetupOutputData ()

virtual int	ReadVTKFile (vtkXMLDataElement *eVTKFile)

vtkAbstractArray *	CreateArray (vtkXMLDataElement *da)

int	CreateInformationKey (vtkXMLDataElement eInfoKey, vtkInformation info)

bool	ReadInformation (vtkXMLDataElement infoRoot, vtkInformation info)

virtual int	OpenStream ()

virtual void	CloseStream ()

virtual int	OpenVTKFile ()

virtual void	CloseVTKFile ()

virtual int	OpenVTKString ()

virtual void	CloseVTKString ()

virtual void	CreateXMLParser ()

virtual void	DestroyXMLParser ()

void	SetupCompressor (const char *type)

int	CanReadFileVersionString (const char *version)

virtual int	CanReadFileWithDataType (const char *dsname)

virtual int	GetFileMajorVersion ()

virtual int	GetFileMinorVersion ()

int	IntersectExtents (int extent1, int extent2, int *result)

int	Min (int a, int b)

int	Max (int a, int b)

void	ComputePointDimensions (int extent, int dimensions)

void	ComputePointIncrements (int extent, vtkIdType increments)

void	ComputeCellDimensions (int extent, int dimensions)

void	ComputeCellIncrements (int extent, vtkIdType increments)

vtkIdType	GetStartTuple (int extent, vtkIdType increments, int i, int j, int k)

void	ReadAttributeIndices (vtkXMLDataElement eDSA, vtkDataSetAttributes dsa)

char **	CreateStringArray (int numStrings)

void	DestroyStringArray (int numStrings, char **strings)

void	SetDataArraySelections (vtkXMLDataElement eDSA, vtkDataArraySelection sel)

int	SetFieldDataInfo (vtkXMLDataElement eDSA, int association, int numTuples, vtkInformationVector (&infoVector))

int	PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)

int	CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)

virtual void	SqueezeOutputArrays (vtkDataObject *)

virtual void	GetProgressRange (float *range)

virtual void	SetProgressRange (const float range[2], int curStep, int numSteps)

virtual void	SetProgressRange (const float range[2], int curStep, const float *fractions)

virtual void	UpdateProgressDiscrete (float progress)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestDataObject (vtkInformation vtkNotUsed(request), vtkInformationVector vtkNotUsed(inputVector), vtkInformationVector vtkNotUsed(outputVector))

void	SetNumberOfTimeSteps (int num)

vtkDataObject *	GetCurrentOutput ()

vtkInformation *	GetCurrentOutputInformation ()

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetErrorCode (unsigned long)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	InternalForceMultiBlock

int	ForceOutputTypeToMultiBlock

vtkXMLCollectionReaderInternals *	Internal

Protected Attributes inherited from vtkXMLReader
vtkXMLDataParser *	XMLParser

vtkXMLDataElement *	FieldDataElement

char *	FileName

istream *	Stream

int	ReadFromInputString

std::string	InputString

vtkDataArraySelection *	PointDataArraySelection

vtkDataArraySelection *	CellDataArraySelection

vtkCallbackCommand *	SelectionObserver

int	InformationError

int	DataError

float	ProgressRange [2]

vtkTimeStamp	ReadMTime

int	ReadError

int	AxesEmpty [3]

int	TimeStep

int	CurrentTimeStep

int	NumberOfTimeSteps

int *	TimeSteps

int	TimeStepRange [2]

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

int	AbortExecute

Static Protected Member Functions inherited from vtkXMLReader
static void	SelectionModifiedCallback (vtkObject caller, unsigned long eid, void clientdata, void *calldata)

static int	IsTimeStepInArray (int timestep, int *timesteps, int length)

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 25 of file vtkXMLCollectionReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkXMLReader vtkXMLCollectionReader::Superclass

Definition at line 29 of file vtkXMLCollectionReader.h.

Constructor & Destructor Documentation

◆ vtkXMLCollectionReader()

vtkXMLCollectionReader::vtkXMLCollectionReader ( )

protected

◆ ~vtkXMLCollectionReader()

vtkXMLCollectionReader::~vtkXMLCollectionReader ( )

overrideprotected

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 from vtkXMLReader.

Reimplemented in vtkPVDReader.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkXMLReader.

◆ 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 nullptr 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 nullptr 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()

const char* vtkXMLCollectionReader::GetDataSetName ( )

overrideprotectedvirtual

Implements vtkXMLReader.

◆ ReadPrimaryElement()

int vtkXMLCollectionReader::ReadPrimaryElement ( vtkXMLDataElement * ePrimary )

overrideprotectedvirtual

Reimplemented from vtkXMLReader.

◆ FillOutputPortInformation()

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

overrideprotectedvirtual

Reimplemented from vtkAlgorithm.

◆ SetupOutput()

vtkDataObject* vtkXMLCollectionReader::SetupOutput	(	const std::string &	filePath,
		int	index
	)

protected

◆ SetupReader()

vtkXMLReader* vtkXMLCollectionReader::SetupReader	(	const std::string &	filePath,
		int	index
	)

protected

Ensures that an appropriate reader is setup for the specified index.

◆ RequestDataObject()

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

overrideprotected

◆ RequestInformation()

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

overrideprotectedvirtual

Reimplemented from vtkXMLReader.

◆ SetupEmptyOutput()

void vtkXMLCollectionReader::SetupEmptyOutput ( )

overrideprotectedvirtual

Implements vtkXMLReader.

◆ ReadXMLData()

void vtkXMLCollectionReader::ReadXMLData ( )

overrideprotectedvirtual

Reimplemented from vtkXMLReader.

◆ ReadXMLDataImpl()

void vtkXMLCollectionReader::ReadXMLDataImpl ( )

protected

◆ 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

◆ FillArraySelectionUsingReaders()

void vtkXMLCollectionReader::FillArraySelectionUsingReaders ( const std::string & filePath )

protected

iterating over all readers (which corresponds to number of distinct datasets in the file, and not distinct timesteps), populate this->*ArraySelection objects.

Member Data Documentation

◆ InternalForceMultiBlock

bool vtkXMLCollectionReader::InternalForceMultiBlock

protected

Definition at line 123 of file vtkXMLCollectionReader.h.

◆ ForceOutputTypeToMultiBlock

int vtkXMLCollectionReader::ForceOutputTypeToMultiBlock

protected

Definition at line 124 of file vtkXMLCollectionReader.h.

◆ Internal

vtkXMLCollectionReaderInternals* vtkXMLCollectionReader::Internal

protected

Definition at line 157 of file vtkXMLCollectionReader.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/IOCore/vtkXMLCollectionReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkXMLCollectionReader()

◆ ~vtkXMLCollectionReader()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetRestriction()

◆ GetRestriction()

◆ SetRestrictionAsIndex()

◆ GetRestrictionAsIndex()

◆ GetNumberOfAttributes()

◆ GetAttributeName()

◆ GetAttributeIndex()

◆ GetNumberOfAttributeValues()

◆ GetAttributeValue() [1/2]

◆ GetAttributeValue() [2/2]

◆ GetAttributeValueIndex() [1/2]

◆ GetAttributeValueIndex() [2/2]

◆ GetOutputXMLDataElement()

◆ SetForceOutputTypeToMultiBlock()

◆ GetForceOutputTypeToMultiBlock()

◆ ForceOutputTypeToMultiBlockOn()

◆ ForceOutputTypeToMultiBlockOff()

◆ BuildRestrictedDataSets()

◆ GetDataSetName()

◆ ReadPrimaryElement()

◆ FillOutputPortInformation()

◆ SetupOutput()

◆ SetupReader()

◆ RequestDataObject()

◆ RequestInformation()

◆ SetupEmptyOutput()

◆ ReadXMLData()

◆ ReadXMLDataImpl()

◆ InternalProgressCallback()

◆ AddAttributeNameValue()

◆ SetRestrictionImpl()

◆ ReadAFile()

◆ FillArraySelectionUsingReaders()

Member Data Documentation

◆ InternalForceMultiBlock

◆ ForceOutputTypeToMultiBlock

◆ Internal