VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkXMLHierarchicalBoxDataReader Class Reference

Reader for hierarchical datasets. More...

#include <vtkXMLHierarchicalBoxDataReader.h>

Inheritance diagram for vtkXMLHierarchicalBoxDataReader:
[legend]
Collaboration diagram for vtkXMLHierarchicalBoxDataReader:
[legend]

Public Types

typedef vtkXMLCompositeDataReader Superclass
- Public Types inherited from vtkXMLCompositeDataReader
typedef vtkXMLReader Superclass
- Public Types inherited from vtkXMLReader
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
- Public Member Functions inherited from vtkXMLCompositeDataReader
vtkCompositeDataSetGetOutput ()
vtkCompositeDataSetGetOutput (int)
- Public Member Functions inherited from vtkXMLReader
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 ()
vtkDataSetGetOutputAsDataSet ()
vtkDataSetGetOutputAsDataSet (int index)
virtual vtkDataArraySelectionGetPointDataArraySelection ()
virtual vtkDataArraySelectionGetCellDataArraySelection ()
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])
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (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 *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static
vtkXMLHierarchicalBoxDataReader
New ()
static int IsTypeOf (const char *type)
static
vtkXMLHierarchicalBoxDataReader
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkXMLHierarchicalBoxDataReader ()
 ~vtkXMLHierarchicalBoxDataReader ()
virtual const char * GetDataSetName ()
virtual int FillOutputPortInformation (int, vtkInformation *info)
virtual void ReadComposite (vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex)
virtual vtkDataSetReadDataset (vtkXMLDataElement *xmlElem, const char *filePath)
virtual void ReadVersion0 (vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex)
- Protected Member Functions inherited from vtkXMLCompositeDataReader
 vtkXMLCompositeDataReader ()
 ~vtkXMLCompositeDataReader ()
vtkXMLDataElementGetPrimaryElement ()
virtual void ReadXMLData ()
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
virtual void SetupEmptyOutput ()
virtual vtkExecutiveCreateDefaultExecutive ()
vtkXMLReaderGetReaderOfType (const char *type)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void AddChild (vtkCompositeDataSet *parent, vtkDataObject *child, vtkXMLDataElement *childXML)
unsigned int CountLeaves (vtkXMLDataElement *elem)
int ShouldReadDataSet (unsigned int datasetIndex)
virtual int CanReadFileVersion (int major, int vtkNotUsed(minor))
- Protected Member Functions inherited from vtkXMLReader
 vtkXMLReader ()
 ~vtkXMLReader ()
virtual int ReadXMLInformation ()
virtual int CanReadFileVersion (int major, int minor)
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
virtual void SetupUpdateExtentInformation (vtkInformation *vtkNotUsed(outInfo))
virtual void SetupOutputData ()
int ReadVTKFile (vtkXMLDataElement *eVTKFile)
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
virtual int OpenVTKFile ()
virtual void CloseVTKFile ()
virtual void CreateXMLParser ()
virtual void DestroyXMLParser ()
void SetupCompressor (const char *type)
int CanReadFileVersionString (const char *version)
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 GetProgressRange (float *range)
virtual void SetProgressRange (float *range, int curStep, int numSteps)
virtual void SetProgressRange (float *range, int curStep, 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))
virtual int RequestUpdateExtentInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void SetNumberOfTimeSteps (int num)
vtkDataObjectGetCurrentOutput ()
vtkInformationGetCurrentOutputInformation ()
- 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 void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
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)
- Protected Attributes inherited from vtkXMLReader
vtkXMLDataParserXMLParser
vtkXMLDataElementFieldDataElement
char * FileName
istream * Stream
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkCallbackCommandSelectionObserver
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]
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

Reader for hierarchical datasets.

vtkXMLHierarchicalBoxDataReader reads the VTK XML hierarchical data file format. XML hierarchical data files are meta-files that point to a list of serial VTK XML files. When reading in parallel, it will distribute sub-blocks among processor. If the number of sub-blocks is less than the number of processors, some processors will not have any sub-blocks for that level. If the number of sub-blocks is larger than the number of processors, each processor will possibly have more than 1 sub-block.

Examples:
vtkXMLHierarchicalBoxDataReader (Examples)
Tests:
vtkXMLHierarchicalBoxDataReader (Tests)

Definition at line 39 of file vtkXMLHierarchicalBoxDataReader.h.

Member Typedef Documentation

Definition at line 43 of file vtkXMLHierarchicalBoxDataReader.h.

Constructor & Destructor Documentation

vtkXMLHierarchicalBoxDataReader::vtkXMLHierarchicalBoxDataReader ( )
protected
vtkXMLHierarchicalBoxDataReader::~vtkXMLHierarchicalBoxDataReader ( )
protected

Member Function Documentation

static vtkXMLHierarchicalBoxDataReader* vtkXMLHierarchicalBoxDataReader::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkXMLHierarchicalBoxDataReader::GetClassName ( )
virtual

Reimplemented from vtkXMLCompositeDataReader.

static int vtkXMLHierarchicalBoxDataReader::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLCompositeDataReader.

virtual int vtkXMLHierarchicalBoxDataReader::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLCompositeDataReader.

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

Reimplemented from vtkXMLCompositeDataReader.

void vtkXMLHierarchicalBoxDataReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkXMLCompositeDataReader.

virtual const char* vtkXMLHierarchicalBoxDataReader::GetDataSetName ( )
protectedvirtual

Reimplemented from vtkXMLCompositeDataReader.

virtual int vtkXMLHierarchicalBoxDataReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkXMLCompositeDataReader.

virtual void vtkXMLHierarchicalBoxDataReader::ReadComposite ( vtkXMLDataElement element,
vtkCompositeDataSet composite,
const char *  filePath,
unsigned int &  dataSetIndex 
)
protectedvirtual
virtual vtkDataSet* vtkXMLHierarchicalBoxDataReader::ReadDataset ( vtkXMLDataElement xmlElem,
const char *  filePath 
)
protectedvirtual

Reimplemented from vtkXMLCompositeDataReader.

virtual void vtkXMLHierarchicalBoxDataReader::ReadVersion0 ( vtkXMLDataElement element,
vtkCompositeDataSet composite,
const char *  filePath,
unsigned int &  dataSetIndex 
)
protectedvirtual

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