VTK  9.3.20240418
vtkInformationQuadratureSchemeDefinitionVectorKey.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
13 #ifndef vtkInformationQuadratureSchemeDefinitionVectorKey_h
14 #define vtkInformationQuadratureSchemeDefinitionVectorKey_h
15 
16 #include "vtkCommonDataModelModule.h" // For export macro
17 #include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
18 #include "vtkInformationKey.h"
19 
20 VTK_ABI_NAMESPACE_BEGIN
21 class vtkInformationQuadratureSchemeDefinitionVectorValue;
22 class vtkXMLDataElement;
24 
26  : public vtkInformationKey
27 {
28 public:
30  void PrintSelf(ostream& os, vtkIndent indent) override;
32 
37  //
40 
49  void Resize(vtkInformation* info, int n);
54  int Length(vtkInformation* info) { return this->Size(info); }
69  void SetRange(
70  vtkInformation* info, vtkQuadratureSchemeDefinition** source, int from, int to, int n);
71 
77  void GetRange(
78  vtkInformation* info, vtkQuadratureSchemeDefinition** dest, int from, int to, int n);
79 
84 
85  // _escription:
86  // Get a pointer to the first vtkQuadratureSchemeDefinition in the vector. We are
87  // uysing a vector of smart pointers so this is not easy to
88  // implement.
89  // vtkQuadratureSchemeDefinition **Get(vtkInformation* info);
90 
92 
97  void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
98  void DeepCopy(vtkInformation* from, vtkInformation* to) override;
100 
104  void Print(ostream& os, vtkInformation* info) override;
105 
106  // note: I had wanted to make the following interface in vtkInformationKey
107  // with a default implementation that did nothing. but we decided that
108  // vtkInformationKey class is too important a class to add such an interface
109  // without a thorough design review. we don't have budget for such a review.
110 
122 
123 private:
128  void CreateQuadratureSchemeDefinition();
134  vtkInformationQuadratureSchemeDefinitionVectorValue* GetQuadratureSchemeDefinitionVector(
136 
137  //
140  void operator=(const vtkInformationQuadratureSchemeDefinitionVectorKey&) = delete;
141 };
142 
143 VTK_ABI_NAMESPACE_END
144 #endif
a simple class to control print indentation
Definition: vtkIndent.h:108
Superclass for vtkInformation keys.
void Append(vtkInformation *info, vtkQuadratureSchemeDefinition *value)
Put the value on the back of the vector, with reference counting.
void Print(ostream &os, vtkInformation *info) override
Print the key's value in an information object to a stream.
void Set(vtkInformation *info, vtkQuadratureSchemeDefinition *value, int i)
Set element i of the vector to value.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetRange(vtkInformation *info, vtkQuadratureSchemeDefinition **source, int from, int to, int n)
Copy n values from the range in source defined by [from from+n-1] into the range in this vector defin...
void ShallowCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkQuadratureSchemeDefinition * Get(vtkInformation *info, int idx)
Get the vtkQuadratureSchemeDefinition at a specific location in the vector.
int RestoreState(vtkInformation *info, vtkXMLDataElement *element)
Load key/value pairs from an XML state representation created with SaveState.
int SaveState(vtkInformation *info, vtkXMLDataElement *element)
Generate an XML representation of the object.
void Clear(vtkInformation *info)
Clear the vector.
int Size(vtkInformation *info)
Get the vector's length.
void GetRange(vtkInformation *info, vtkQuadratureSchemeDefinition **dest, int from, int to, int n)
Copy n values from the range in this vector defined by [from from+n-1] into the range in the destinat...
void DeepCopy(vtkInformation *from, vtkInformation *to) override
Copy the entry associated with this key from one information object to another.
vtkInformationQuadratureSchemeDefinitionVectorKey(const char *name, const char *location)
The name of the static instance and the class in which it is defined(location) should be passed to th...
~vtkInformationQuadratureSchemeDefinitionVectorKey() override
The name of the static instance and the class in which it is defined(location) should be passed to th...
void Resize(vtkInformation *info, int n)
Resize (extend) the vector to hold n objects.
Store vtkAlgorithm input/output information.
An Elemental data type that holds a definition of a numerical quadrature scheme.
Represents an XML element and those nested inside.
@ location
Definition: vtkX3D.h:406
@ info
Definition: vtkX3D.h:376
@ value
Definition: vtkX3D.h:220
@ name
Definition: vtkX3D.h:219
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)