File: vtkSMChartSeriesListDomain.h

package info (click to toggle)
paraview 5.1.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 221,108 kB
  • ctags: 236,092
  • sloc: cpp: 2,416,026; ansic: 190,891; python: 99,856; xml: 81,001; tcl: 46,915; yacc: 5,039; java: 4,413; perl: 3,108; sh: 1,974; lex: 1,926; f90: 748; asm: 471; pascal: 228; makefile: 198; objc: 83; fortran: 31
file content (85 lines) | stat: -rw-r--r-- 3,183 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile$

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
// .NAME vtkSMChartSeriesListDomain - list of strings corresponding to the names
// of the arrays in the required input dataset that can be used as a series in a
// chart.
// .SECTION Description
// vtkSMChartSeriesListDomain is designed to be used for the X-axis array name
// property on chart representations. This is similar to vtkSMArrayListDomain,
// however, it simplifies the logic that is uses to determine the available
// arrays and at the same time, uses custom logic to pick the default array for
// based on priorities for arrays.
//
// Supported Required-Property functions:
// \li \c Input : (required) refers to a property that provides the data-producer.
// \li \c FieldDataSelection : (required) refers to a field-selection property
// used to select the data-association i.e. cell-data, point-data etc.
//
// Supported XML attributes
// \li hide_partial_arrays : when set to 1, partial arrays will not be shown in
// the domain (default).
#ifndef vtkSMChartSeriesListDomain_h
#define vtkSMChartSeriesListDomain_h

#include "vtkSMStringListDomain.h"
#include "vtkPVServerManagerRenderingModule.h" // needed for exports

class vtkPVArrayInformation;
class vtkPVDataInformation;

class VTKPVSERVERMANAGERRENDERING_EXPORT vtkSMChartSeriesListDomain :
  public vtkSMStringListDomain
{
public:
  static vtkSMChartSeriesListDomain* New();
  vtkTypeMacro(vtkSMChartSeriesListDomain, vtkSMStringListDomain);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Update self checking the "unchecked" values of all required
  // properties. Overwritten by sub-classes.
  virtual void Update(vtkSMProperty*);

  // Description:
  // Set the default values for the property.
  virtual int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values);

  // Description:
  // Returns the list of series that are know to this domain are are given a
  // priority when setting default values. This array is NULL terminated i.e.
  // the last entry in this array will be NULL.
  static const char** GetKnownSeriesNames();

protected:
  vtkSMChartSeriesListDomain();
  ~vtkSMChartSeriesListDomain();

  // Description:
  // Returns the datainformation from the current input, if possible.
  vtkPVDataInformation* GetInputInformation();

  virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element);

  virtual void PopulateArrayComponents(
    vtkPVArrayInformation*, std::vector<vtkStdString>&);

  bool HidePartialArrays;
private:
  vtkSMChartSeriesListDomain(const vtkSMChartSeriesListDomain&); // Not implemented
  void operator=(const vtkSMChartSeriesListDomain&); // Not implemented

};

#endif