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 86 87 88 89 90 91 92 93 94 95 96
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkInformationExecutivePortVectorKey
* @brief Key for vtkExecutive/Port value pair vectors.
*
* vtkInformationExecutivePortVectorKey is used to represent keys in
* vtkInformation for values that are vectors of vtkExecutive
* instances paired with port numbers.
*/
#ifndef vtkInformationExecutivePortVectorKey_h
#define vtkInformationExecutivePortVectorKey_h
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkInformationKey.h"
#include "vtkFilteringInformationKeyManager.h" // Manage instances of this type.
VTK_ABI_NAMESPACE_BEGIN
class vtkExecutive;
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkInformationExecutivePortVectorKey : public vtkInformationKey
{
public:
vtkTypeMacro(vtkInformationExecutivePortVectorKey, vtkInformationKey);
void PrintSelf(ostream& os, vtkIndent indent) override;
vtkInformationExecutivePortVectorKey(const char* name, const char* location);
~vtkInformationExecutivePortVectorKey() override;
/**
* This method simply returns a new vtkInformationExecutivePortVectorKey,
* given a name and a location. This method is provided for wrappers. Use
* the constructor directly from C++ instead.
*/
static VTK_NEWINSTANCE vtkInformationExecutivePortVectorKey* MakeKey(
const char* name, const char* location)
{
return new vtkInformationExecutivePortVectorKey(name, location);
}
///@{
/**
* Get/Set the value associated with this key in the given
* information object.
*/
void Append(vtkInformation* info, vtkExecutive* executive, int port);
void Remove(vtkInformation* info, vtkExecutive* executive, int port);
void Set(vtkInformation* info, vtkExecutive** executives, int* ports, int length);
vtkExecutive** GetExecutives(vtkInformation* info);
int* GetPorts(vtkInformation* info);
void Get(vtkInformation* info, vtkExecutive** executives, int* ports);
int Length(vtkInformation* info);
///@}
/**
* Copy the entry associated with this key from one information
* object to another. If there is no entry in the first information
* object for this key, the value is removed from the second.
*/
void ShallowCopy(vtkInformation* from, vtkInformation* to) override;
/**
* Remove this key from the given information object.
*/
void Remove(vtkInformation* info) override;
/**
* Report a reference this key has in the given information object.
*/
void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
/**
* Print the key's value in an information object to a stream.
*/
void Print(ostream& os, vtkInformation* info) override;
protected:
///@{
/**
* Get the address at which the actual value is stored. This is
* meant for use from a debugger to add watches and is therefore not
* a public method.
*/
vtkExecutive** GetExecutivesWatchAddress(vtkInformation* info);
int* GetPortsWatchAddress(vtkInformation* info);
///@}
private:
vtkInformationExecutivePortVectorKey(const vtkInformationExecutivePortVectorKey&) = delete;
void operator=(const vtkInformationExecutivePortVectorKey&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|