#include <vtkXdmf3ArraySelection.h>

Detailed Description

helper to identify requested arrays with

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

Definition at line 28 of file vtkXdmf3ArraySelection.h.

Inherits std::map< std::string, bool >.

Public Member Functions
void	Merge (const vtkXdmf3ArraySelection &other)
	used in parallel to send of combine sets

void	AddArray (const char *name, bool status=true)
	add a new array to the set, with a particular status

bool	ArrayIsEnabled (const char *name)
	test if a particular array is enablled or not

bool	HasArray (const char *name)
	check if a particular array is in the set yet or not

const char *	GetArrayName (int index)
	get string name of a particular array

int	GetNumberOfArrays ()
	get number of arrays in the set


void	SetArrayStatus (const char *name, bool status)
	get/set user choice of whether a particular array is to be loaded

int	GetArraySetting (const char *name)
	get/set user choice of whether a particular array is to be loaded

Member Function Documentation

◆ Merge()

void vtkXdmf3ArraySelection::Merge ( const vtkXdmf3ArraySelection & other )

used in parallel to send of combine sets

◆ AddArray()

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

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

◆ ArrayIsEnabled()

bool vtkXdmf3ArraySelection::ArrayIsEnabled ( const char * name )

test if a particular array is enablled or not

◆ HasArray()

bool vtkXdmf3ArraySelection::HasArray ( const char * name )

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

◆ SetArrayStatus()

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

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

◆ GetArraySetting()

int vtkXdmf3ArraySelection::GetArraySetting ( const char * name )

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

◆ GetArrayName()

const char * vtkXdmf3ArraySelection::GetArrayName ( int index )

get string name of a particular array

◆ GetNumberOfArrays()

int vtkXdmf3ArraySelection::GetNumberOfArrays ( )

get number of arrays in the set

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

IO/Xdmf3/vtkXdmf3ArraySelection.h