vtkXdmf3ArraySelection Class Reference

helper to identify requested arrays with More...

#include <vtkXdmf3ArraySelection.h>

Inherits map< std::string, bool >.

Public Member Functions
void	Merge (const vtkXdmf3ArraySelection &other)
void	AddArray (const char *name, bool status=true)
bool	ArrayIsEnabled (const char *name)
bool	HasArray (const char *name)
const char *	GetArrayName (int index)
void	SetArrayStatus (const char *name, bool status)
int	GetArraySetting (const char *name)
int	GetNumberOfArrays ()

Detailed Description

helper to identify requested arrays with

$Date$ $Revision$

Used by ParaView GUI to mark arrays, sets, and blocks that reader can optionally read in. Note: we use it for more than just arrays but Paraview code requires "Array" name in the API.

This file is a helper for the vtkXdmf3Reader and not intended to be part of VTK public API VTK-HeaderTest-Exclude: vtkXdmf3ArraySelection.h

Definition at line 39 of file vtkXdmf3ArraySelection.h.

Member Function Documentation

void vtkXdmf3ArraySelection::Merge

(

const vtkXdmf3ArraySelection &

other

)

used in parallel to send of combine sets

void vtkXdmf3ArraySelection::AddArray	(	const char *	name,
		bool	status = true
	)

add a new array to the set, with a particular status

bool vtkXdmf3ArraySelection::ArrayIsEnabled

(

const char *

name

)

test if a particular array is enablled or not

bool vtkXdmf3ArraySelection::HasArray

(

const char *

name

)

check if a particular array is in the set yet or not

void vtkXdmf3ArraySelection::SetArrayStatus	(	const char *	name,
		bool	status
	)

get/set user choice of whether a particular array is to be loaded

int vtkXdmf3ArraySelection::GetArraySetting

(

const char *

name

)

get/set user choice of whether a particular array is to be loaded

const char* vtkXdmf3ArraySelection::GetArrayName

(

int

index

)

get string name of a particular array

int vtkXdmf3ArraySelection::GetNumberOfArrays

(

)

get number of arrays in the set

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Xdmf3/vtkXdmf3ArraySelection.h