ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAnnotateGlobalDataFilter Class Reference

filter for annotating with global data (designed for ExodusII reader). More...

#include <vtkAnnotateGlobalDataFilter.h>

Inheritance diagram for vtkAnnotateGlobalDataFilter:
Inheritance graph
[legend]
Collaboration diagram for vtkAnnotateGlobalDataFilter:
Collaboration graph
[legend]

Public Types

typedef vtkPythonAnnotationFilter Superclass
 
- Public Types inherited from vtkPythonAnnotationFilter
typedef vtkTableAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetFieldArrayName (const char *)
 Name of the field to display. More...
 
virtual char * GetFieldArrayName ()
 Name of the field to display. More...
 
virtual void SetPrefix (const char *)
 Set the text prefix to display in front of the Field value. More...
 
virtual char * GetPrefix ()
 Set the text prefix to display in front of the Field value. More...
 
virtual void SetPostfix (const char *)
 Set the text prefix to display in front of the Field value. More...
 
virtual char * GetPostfix ()
 Set the text prefix to display in front of the Field value. More...
 
- Public Member Functions inherited from vtkPythonAnnotationFilter
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetNumberOfTimeSteps ()
 
double GetTimeStep (int index)
 
virtual bool GetTimeRangeValid ()
 
virtual double * GetTimeRange ()
 
virtual void GetTimeRange (double &, double &)
 
virtual void GetTimeRange (double [2])
 
virtual vtkDataObject * GetCurrentInputDataObject ()
 
void SetComputedAnnotationValue (const char *value)
 
virtual void SetExpression (const char *)
 Set the expression to evaluate. More...
 
virtual char * GetExpression ()
 Set the expression to evaluate. More...
 
virtual void SetArrayAssociation (int)
 Set the input array association. More...
 
virtual int GetArrayAssociation ()
 Set the input array association. More...
 
virtual char * GetComputedAnnotationValue ()
 Get the value that is going to be printed to the output. More...
 
virtual bool GetDataTimeValid ()
 Get methods for use in annotation.py. More...
 
virtual double GetDataTime ()
 Get methods for use in annotation.py. More...
 

Static Public Member Functions

static vtkAnnotateGlobalDataFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAnnotateGlobalDataFilterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPythonAnnotationFilter
static vtkPythonAnnotationFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPythonAnnotationFilterSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkAnnotateGlobalDataFilter ()
 
 ~vtkAnnotateGlobalDataFilter ()
 
virtual void EvaluateExpression ()
 
- Protected Member Functions inherited from vtkPythonAnnotationFilter
 vtkPythonAnnotationFilter ()
 
 ~vtkPythonAnnotationFilter ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Protected Attributes

char * Prefix
 
char * Postfix
 
char * FieldArrayName
 
- Protected Attributes inherited from vtkPythonAnnotationFilter
char * Expression
 
char * ComputedAnnotationValue
 
int ArrayAssociation
 

Detailed Description

filter for annotating with global data (designed for ExodusII reader).

vtkAnnotateGlobalDataFilter provides a simpler API for creating text annotations using vtkPythonAnnotationFilter. Instead of users specifying the annotation expression, this filter determines the expression based on the array selected by limiting the scope of the functionality. This filter only allows the user to annotate using "global-data" aka field data and specify the string prefix to use. If the field array chosen has as many elements as number of timesteps, the array is assumed to be "temporal" and indexed using the current timestep.

Definition at line 36 of file vtkAnnotateGlobalDataFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkAnnotateGlobalDataFilter.h.

Constructor & Destructor Documentation

◆ vtkAnnotateGlobalDataFilter()

vtkAnnotateGlobalDataFilter::vtkAnnotateGlobalDataFilter ( )
protected

◆ ~vtkAnnotateGlobalDataFilter()

vtkAnnotateGlobalDataFilter::~vtkAnnotateGlobalDataFilter ( )
protected

Member Function Documentation

◆ New()

static vtkAnnotateGlobalDataFilter* vtkAnnotateGlobalDataFilter::New ( )
static

◆ GetClassName()

virtual const char* vtkAnnotateGlobalDataFilter::GetClassName ( )
virtual

Reimplemented from vtkPythonAnnotationFilter.

◆ IsTypeOf()

static int vtkAnnotateGlobalDataFilter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkAnnotateGlobalDataFilter::IsA ( const char *  type)
virtual

Reimplemented from vtkPythonAnnotationFilter.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetFieldArrayName()

virtual void vtkAnnotateGlobalDataFilter::SetFieldArrayName ( const char *  )
virtual

Name of the field to display.

◆ GetFieldArrayName()

virtual char* vtkAnnotateGlobalDataFilter::GetFieldArrayName ( )
virtual

Name of the field to display.

◆ SetPrefix()

virtual void vtkAnnotateGlobalDataFilter::SetPrefix ( const char *  )
virtual

Set the text prefix to display in front of the Field value.

◆ GetPrefix()

virtual char* vtkAnnotateGlobalDataFilter::GetPrefix ( )
virtual

Set the text prefix to display in front of the Field value.

◆ SetPostfix()

virtual void vtkAnnotateGlobalDataFilter::SetPostfix ( const char *  )
virtual

Set the text prefix to display in front of the Field value.

◆ GetPostfix()

virtual char* vtkAnnotateGlobalDataFilter::GetPostfix ( )
virtual

Set the text prefix to display in front of the Field value.

◆ EvaluateExpression()

virtual void vtkAnnotateGlobalDataFilter::EvaluateExpression ( )
protectedvirtual

Reimplemented from vtkPythonAnnotationFilter.

Member Data Documentation

◆ Prefix

char* vtkAnnotateGlobalDataFilter::Prefix
protected

Definition at line 74 of file vtkAnnotateGlobalDataFilter.h.

◆ Postfix

char* vtkAnnotateGlobalDataFilter::Postfix
protected

Definition at line 75 of file vtkAnnotateGlobalDataFilter.h.

◆ FieldArrayName

char* vtkAnnotateGlobalDataFilter::FieldArrayName
protected

Definition at line 76 of file vtkAnnotateGlobalDataFilter.h.


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