VTK  9.1.0
Public Member Functions | List of all members
vtkADIOS2ArraySelection Class Reference

helper to identify requested arrays with More...

#include <vtkADIOS2CoreArraySelection.h>

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

Public Member Functions

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 map yet or not
 
const char * GetArrayName (int index)
 get name of a particular array
 
int GetNumberOfArrays ()
 get number of arrays in the map
 
void SetArrayStatus (const char *name, bool status)
 get/set user choice of whether a particular array is to be loaded
 
int GetArrayStatus (const char *name)
 get/set user choice of whether a particular array is to be loaded
 

Detailed Description

helper to identify requested arrays with

Used to mark arrays that reader can optionally read in. Needed for ParaView GUI usage.

This file is a helper for the vtkADIOS2CoreImageReader and not intended to be part of VTK public API

Definition at line 39 of file vtkADIOS2CoreArraySelection.h.

Member Function Documentation

◆ AddArray()

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

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

◆ ArrayIsEnabled()

bool vtkADIOS2ArraySelection::ArrayIsEnabled ( const char *  name)

test if a particular array is enablled or not

◆ HasArray()

bool vtkADIOS2ArraySelection::HasArray ( const char *  name)

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

◆ SetArrayStatus()

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

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

◆ GetArrayStatus()

int vtkADIOS2ArraySelection::GetArrayStatus ( const char *  name)

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

◆ GetArrayName()

const char * vtkADIOS2ArraySelection::GetArrayName ( int  index)

get name of a particular array

◆ GetNumberOfArrays()

int vtkADIOS2ArraySelection::GetNumberOfArrays ( )

get number of arrays in the map


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