You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
2.9 KiB
C++
88 lines
2.9 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkInformationObjectBaseKey.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkInformationObjectBaseKey
|
|
* @brief Key for vtkObjectBase values.
|
|
*
|
|
* vtkInformationObjectBaseKey is used to represent keys in
|
|
* vtkInformation for values that are vtkObjectBase instances.
|
|
*/
|
|
|
|
#ifndef vtkInformationObjectBaseKey_h
|
|
#define vtkInformationObjectBaseKey_h
|
|
|
|
#include "vtkCommonCoreModule.h" // For export macro
|
|
#include "vtkInformationKey.h"
|
|
|
|
#include "vtkCommonInformationKeyManager.h" // Manage instances of this type.
|
|
|
|
class vtkObjectBase;
|
|
|
|
class VTKCOMMONCORE_EXPORT vtkInformationObjectBaseKey : public vtkInformationKey
|
|
{
|
|
public:
|
|
vtkTypeMacro(vtkInformationObjectBaseKey, vtkInformationKey);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
|
|
vtkInformationObjectBaseKey(
|
|
const char* name, const char* location, const char* requiredClass = nullptr);
|
|
~vtkInformationObjectBaseKey() override;
|
|
|
|
/**
|
|
* This method simply returns a new vtkInformationObjectBaseKey, given a
|
|
* name, location and optionally a required class (a classname to restrict
|
|
* which class types can be set with this key). This method is provided
|
|
* for wrappers. Use the constructor directly from C++ instead.
|
|
*/
|
|
static vtkInformationObjectBaseKey* MakeKey(
|
|
const char* name, const char* location, const char* requiredClass = nullptr)
|
|
{
|
|
return new vtkInformationObjectBaseKey(name, location, requiredClass);
|
|
}
|
|
|
|
//@{
|
|
/**
|
|
* Get/Set the value associated with this key in the given
|
|
* information object.
|
|
*/
|
|
void Set(vtkInformation* info, vtkObjectBase*);
|
|
vtkObjectBase* Get(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;
|
|
|
|
/**
|
|
* Report a reference this key has in the given information object.
|
|
*/
|
|
void Report(vtkInformation* info, vtkGarbageCollector* collector) override;
|
|
|
|
protected:
|
|
// The type required of all objects stored with this key.
|
|
const char* RequiredClass;
|
|
|
|
vtkInformationKeySetStringMacro(RequiredClass);
|
|
|
|
private:
|
|
vtkInformationObjectBaseKey(const vtkInformationObjectBaseKey&) = delete;
|
|
void operator=(const vtkInformationObjectBaseKey&) = delete;
|
|
};
|
|
|
|
#endif
|