Build a vtkmDataArray over memory VTK did not allocate.
Wraps externally owned host or device memory as a vtkmDataArray, without copying, so data produced elsewhere – a simulation, CuPy, PyTorch, Tack – can be fed straight into Viskores-accelerated filters and stay where it is.
virtual void SetNumberOfTuples(vtkIdType)
Number of tuples in the array to create.
virtual void SetNumberOfComponents(int)
Number of components per tuple.
void AddBuffer(vtkMemoryDescriptor *descriptor)
Add a buffer descriptor.
virtual void SetDataType(int)
The VTK data type (VTK_FLOAT, VTK_DOUBLE, VTK_INT, VTK_LONG_LONG, ...).
vtkDataArray * CreateArray()
Create the vtkmDataArray, or nullptr on error.
One buffer gives AoS, NumberOfComponents buffers give SoA (up to 4).
Ownership
Wrapping memory does not copy it, so something has to keep it alive for as long as Viskores might read it – which is longer than the caller can predict, because a filter may hold an array handle well past the call that created it.
CreateArray() therefore takes each descriptor's release (vtkMemoryDescriptor::TakeRelease) and installs it as the deleter on the Viskores buffer. The producer's hold is then dropped exactly when Viskores is finished with the memory, which is the only moment that is correct.
A descriptor holding a VTK owner rather than a release callback is handled the same way, by holding a reference for the buffer's lifetime.
A descriptor with no ownership at all is accepted – some callers really do manage lifetime themselves – but it is a deliberate choice, and a warning says so, because the failure it invites is a use-after-free on device memory, which reports itself as wrong numbers rather than a crash.
Resizing
External memory cannot be reallocated, so the buffers are installed with Viskores' InvalidRealloc, which throws viskores::cont::ErrorBadAllocation if a filter tries to grow them. That is deliberate: the alternative – a reallocation function that silently does nothing – leaves Viskores believing it has more memory than it does, and writing past the end of the caller's buffer.
- See also
- vtkMemoryDescriptor, vtkmDataArray
Definition at line 74 of file vtkmDataArrayFactory.h.
|
| virtual vtkTypeBool | IsA (const char *type) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| vtkmDataArrayFactory * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| void | AddBuffer (vtkMemoryDescriptor *descriptor) |
| | Add a buffer descriptor.
|
| void | ClearBuffers () |
| | Drop all added descriptors without creating an array.
|
| int | GetNumberOfBuffers () const |
| | Number of buffers added so far.
|
| vtkDataArray * | CreateArray () |
| | Create the vtkmDataArray, or nullptr on error.
|
| virtual void | SetNumberOfTuples (vtkIdType) |
| | Number of tuples in the array to create.
|
| virtual vtkIdType | GetNumberOfTuples () |
| | Number of tuples in the array to create.
|
| virtual void | SetNumberOfComponents (int) |
| | Number of components per tuple.
|
| virtual int | GetNumberOfComponents () |
| | Number of components per tuple.
|
| virtual void | SetDataType (int) |
| | The VTK data type (VTK_FLOAT, VTK_DOUBLE, VTK_INT, VTK_LONG_LONG, ...).
|
| virtual int | GetDataType () |
| | The VTK data type (VTK_FLOAT, VTK_DOUBLE, VTK_INT, VTK_LONG_LONG, ...).
|
| | vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
| virtual void | DebugOn () |
| | Turn debugging output on.
|
| virtual void | DebugOff () |
| | Turn debugging output off.
|
| bool | GetDebug () |
| | Get the value of the debug flag.
|
| void | SetDebug (bool debugFlag) |
| | Set the value of the debug flag.
|
| virtual void | Modified () |
| | Update the modification time for this object.
|
| virtual vtkMTimeType | GetMTime () |
| | Return this object's modified time.
|
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| vtkTypeBool | InvokeEvent (unsigned long event) |
| vtkTypeBool | InvokeEvent (const char *event) |
| std::string | GetObjectDescription () const override |
| | The object description printed in messages and PrintSelf output.
|
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkCommand * | GetCommand (unsigned long tag) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObserver (vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObservers (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Allow user to set the AbortFlagOn() with the return value of the callback method.
|
| vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| virtual void | SetObjectName (const std::string &objectName) |
| | Set/get the name of this object for reporting purposes.
|
| virtual std::string | GetObjectName () const |
| | Set/get the name of this object for reporting purposes.
|
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| | Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| virtual void | Delete () |
| | Delete a VTK object.
|
| virtual void | FastDelete () |
| | Delete a reference to this object.
|
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| | Print an object to an ostream.
|
| void | Register (vtkObjectBase *o) |
| | Increase the reference count (mark as used by another object).
|
| virtual void | UnRegister (vtkObjectBase *o) |
| | Decrease the reference count (release by another object).
|
| int | GetReferenceCount () |
| | Return the current reference count of this object.
|
| void | SetReferenceCount (int) |
| | Sets the reference count.
|
| bool | GetIsInMemkind () const |
| | A local state flag that remembers whether this object lives in the normal or extended memory space.
|
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| virtual bool | UsesGarbageCollector () const |
| | Indicate whether the class uses vtkGarbageCollector or not.
|
|
| static vtkmDataArrayFactory * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkmDataArrayFactory * | SafeDownCast (vtkObjectBase *o) |
| static vtkObject * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| static void | BreakOnError () |
| | This method is called when vtkErrorMacro executes.
|
| static void | SetGlobalWarningDisplay (vtkTypeBool val) |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static void | GlobalWarningDisplayOn () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static void | GlobalWarningDisplayOff () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static vtkTypeBool | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static vtkTypeBool | IsTypeOf (const char *name) |
| | Return 1 if this class type is the same type of (or a subclass of) the named class.
|
| static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| | Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| static vtkObjectBase * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| static void | SetMemkindDirectory (const char *directoryname) |
| | The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
| static bool | GetUsingMemkind () |
| | A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
1.16.1