vtkPVProminentValuesInformation.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
20 #ifndef vtkPVProminentValuesInformation_h
21 #define vtkPVProminentValuesInformation_h
22 
23 #include "vtkPVInformation.h"
24 #include "vtkRemotingViewsModule.h" //needed for exports
25 
26 class vtkAbstractArray;
29 class vtkDataObject;
30 class vtkStringArray;
31 
32 class VTKREMOTINGVIEWS_EXPORT vtkPVProminentValuesInformation : public vtkPVInformation
33 {
34 public:
37  void PrintSelf(ostream& os, vtkIndent indent) override;
38 
40 
43  vtkSetMacro(PortNumber, int);
44  vtkGetMacro(PortNumber, int);
46 
48 
51  vtkSetStringMacro(FieldAssociation);
52  vtkGetStringMacro(FieldAssociation);
54 
56 
59  vtkSetStringMacro(FieldName);
60  vtkGetStringMacro(FieldName);
62 
64 
67  void SetNumberOfComponents(int numComps);
68  vtkGetMacro(NumberOfComponents, int);
70 
72 
79  vtkSetClampMacro(Fraction, double, 0., 1.);
80  vtkGetMacro(Fraction, double);
82 
84 
89  vtkSetClampMacro(Uncertainty, double, 0., 1.);
90  vtkGetMacro(Uncertainty, double);
92 
94 
102  vtkSetMacro(Force, bool);
103  vtkGetMacro(Force, bool);
104 
106 
111  vtkGetMacro(Valid, bool);
112 
117  int Compare(vtkPVProminentValuesInformation* info);
118 
123 
127  void CopyFromObject(vtkObject*) override;
128 
135  virtual void CopyDistinctValuesFromObject(vtkAbstractArray*);
136 
140  void AddInformation(vtkPVInformation* other) override;
141 
143 
146  void CopyToStream(vtkClientServerStream*) override;
147  void CopyFromStream(const vtkClientServerStream*) override;
149 
151 
157 
163  void InitializeParameters();
164 
168  void Initialize();
169 
173  void AddDistinctValues(vtkPVProminentValuesInformation*);
174 
184  vtkAbstractArray* GetProminentComponentValues(int component);
185 
186 protected:
189 
190  void DeepCopyParameters(vtkPVProminentValuesInformation* other);
191  void CopyFromCompositeDataSet(vtkCompositeDataSet*);
192  void CopyFromLeafDataObject(vtkDataObject*);
193 
198  char* FieldName;
200  double Fraction;
201  double Uncertainty;
202  bool Force;
203  bool Valid;
205 
208 
209  class vtkInternalDistinctValues;
210  vtkInternalDistinctValues* DistinctValues;
211 
213 
215  void operator=(const vtkPVProminentValuesInformation&) = delete;
216 };
217 
218 #endif
DeepCopy
void DeepCopy(vtkPistonReference *self, vtkPistonReference *other)
vtkPVProminentValuesInformation::NumberOfComponents
int NumberOfComponents
Information parameters.
Definition: vtkPVProminentValuesInformation.h:197
vtkPVInformation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkPVProminentValuesInformation
Prominent values a data array takes on.
Definition: vtkPVProminentValuesInformation.h:32
vtkObject::New
static vtkObject * New()
vtkMultiProcessStream
vtkClientServerStream
Store messages for the interpreter.
Definition: vtkClientServerStream.h:23
vtkPVProminentValuesInformation::Uncertainty
double Uncertainty
Information parameters.
Definition: vtkPVProminentValuesInformation.h:201
vtkPVInformation.h
vtkObject
vtkPVProminentValuesInformation::Force
bool Force
Information parameters.
Definition: vtkPVProminentValuesInformation.h:202
vtkCompositeDataSet
vtkPVInformation::CopyParametersToStream
virtual void CopyParametersToStream(vtkMultiProcessStream &)
Serialize/Deserialize the parameters that control how/what information is gathered.
Definition: vtkPVInformation.h:50
vtkPVInformation::operator=
void operator=(const vtkPVInformation &)=delete
vtkPVProminentValuesInformation::FieldAssociation
char * FieldAssociation
Information parameters.
Definition: vtkPVProminentValuesInformation.h:199
vtkPVProminentValuesInformation::Valid
bool Valid
Information parameters.
Definition: vtkPVProminentValuesInformation.h:203
vtkPVInformation::AddInformation
virtual void AddInformation(vtkPVInformation *)
Merge another information object.
vtkIndent
vtkPVInformation::CopyFromObject
virtual void CopyFromObject(vtkObject *)
Transfer information about a single object into this object.
vtkPVProminentValuesInformation::PortNumber
int PortNumber
Information parameters.
Definition: vtkPVProminentValuesInformation.h:196
vtkAbstractArray
vtkPVProminentValuesInformation::FieldName
char * FieldName
Information parameters.
Definition: vtkPVProminentValuesInformation.h:198
vtkPVInformation
Superclass for information objects.
Definition: vtkPVInformation.h:19
vtkStringArray
vtkPVProminentValuesInformation::DistinctValues
vtkInternalDistinctValues * DistinctValues
Definition: vtkPVProminentValuesInformation.h:209
vtkPVInformation::CopyToStream
virtual void CopyToStream(vtkClientServerStream *)=0
Manage a serialized version of the information.
vtkDataObject
vtkPVInformation::CopyFromStream
virtual void CopyFromStream(const vtkClientServerStream *)
Manage a serialized version of the information.
vtkPVInformation::CopyParametersFromStream
virtual void CopyParametersFromStream(vtkMultiProcessStream &)
Serialize/Deserialize the parameters that control how/what information is gathered.
Definition: vtkPVInformation.h:51
vtkPVProminentValuesInformation::Fraction
double Fraction
Information parameters.
Definition: vtkPVProminentValuesInformation.h:200