ParaView
vtkSMCompositeTreeDomain.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMCompositeTreeDomain.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
53 #ifndef vtkSMCompositeTreeDomain_h
54 #define vtkSMCompositeTreeDomain_h
55 
56 #include "vtkPVServerManagerCoreModule.h" //needed for exports
57 #include "vtkSMDomain.h"
58 #include "vtkWeakPointer.h" // needed for vtkWeakPointer.
59 
61 class vtkSMInputProperty;
62 class vtkSMSourceProxy;
63 
64 // TODO: CHANGE NAME OF THIS CLASS
65 class VTKPVSERVERMANAGERCORE_EXPORT vtkSMCompositeTreeDomain : public vtkSMDomain
66 {
67 public:
68  static vtkSMCompositeTreeDomain* New();
70  void PrintSelf(ostream& os, vtkIndent indent);
71 
77  virtual void Update(vtkSMProperty* input);
78 
80 
84  vtkGetObjectMacro(Information, vtkPVDataInformation);
86 
91  vtkSMSourceProxy* GetSource();
92 
94 
98  vtkGetMacro(SourcePort, int);
100 
105  virtual int IsInDomain(vtkSMProperty* vtkNotUsed(property)) { return 1; }
106 
108 
113  vtkGetMacro(Mode, int);
114  vtkSetMacro(Mode, int);
116 
117  enum
118  {
119  ALL = 0,
120  LEAVES = 1,
121  NON_LEAVES = 2,
122  NONE = 3
123  };
124 
126  {
127  DEFAULT = 0,
128  NONEMPTY_LEAF = 1
129  };
130 
132 
138  vtkGetMacro(DefaultMode, int);
139  vtkSetMacro(DefaultMode, int);
141 
152  virtual int SetDefaultValues(vtkSMProperty*, bool use_unchecked_values);
153 
154 protected:
157 
158  virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element);
159 
163  void Update(vtkSMInputProperty* iproperty);
164 
165  void InvokeModifiedIfChanged();
166 
167  void SetInformation(vtkPVDataInformation*);
169 
170  vtkTimeStamp UpdateTime;
171  vtkPVDataInformation* LastInformation; // not reference counted.
172 
173  vtkWeakPointer<vtkSMSourceProxy> Source;
174  int Mode;
177 
178 private:
179  vtkSMCompositeTreeDomain(const vtkSMCompositeTreeDomain&) VTK_DELETE_FUNCTION;
180  void operator=(const vtkSMCompositeTreeDomain&) VTK_DELETE_FUNCTION;
181 };
182 
183 #endif
vtkWeakPointer< vtkSMSourceProxy > Source
Light object for holding data information.
virtual void Update(vtkSMProperty *requestingProperty)
Update self based on the "unchecked" values of all required properties.
Definition: vtkSMDomain.h:65
vtkPVDataInformation * LastInformation
superclass for all SM properties
virtual int SetDefaultValues(vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
A vtkSMProperty is often defined with a default value in the XML itself.
Definition: vtkSMDomain.h:85
virtual int IsInDomain(vtkSMProperty *vtkNotUsed(property))
Is the (unchecked) value of the property in the domain? Overwritten by sub-classes.
represents the possible values a property can have
Definition: vtkSMDomain.h:48
virtual int ReadXMLAttributes(vtkSMProperty *prop, vtkPVXMLElement *elem)
Set the appropriate ivars from the xml element.
proxy for a VTK source on a server
vtkPVDataInformation * Information
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
void PrintSelf(ostream &os, vtkIndent indent)
domain used to restrict an vtkSMIntVectorProperty values to valid flat-index for a vtkCompositeDataSe...
static vtkSMSessionObject * New()
proxy representing inputs to a filter