Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkConduitArrayUtilities Class Reference

helper to convert Conduit arrays to VTK arrays. More...

#include <vtkConduitArrayUtilities.h>

Inheritance diagram for vtkConduitArrayUtilities:
Inheritance graph
[legend]
Collaboration diagram for vtkConduitArrayUtilities:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkConduitArrayUtilitiesNew ()
 
static int IsTypeOf (const char *type)
 
static vtkConduitArrayUtilitiesSafeDownCast (vtkObject *o)
 
static vtkSmartPointer< vtkCellArrayMCArrayToVTKCellArray (vtkIdType cellSize, const conduit_node *mcarray)
 Converts an mcarray to vtkCellArray. More...
 
static vtkSmartPointer< vtkDataArraySetNumberOfComponents (vtkDataArray *array, int num_components)
 If the number of components in the array does not match the target, a new array is created. More...
 
static vtkSmartPointer< vtkDataArrayMCArrayToVTKArray (const conduit_node *mcarray)
 Returns a vtkDataArray from a conduit node in the conduit mcarray protocol. More...
 
static vtkSmartPointer< vtkDataArrayMCArrayToVTKArray (const conduit_node *mcarray, const std::string &arrayname)
 Returns a vtkDataArray from a conduit node in the conduit mcarray protocol. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkConduitArrayUtilities ()
 
 ~vtkConduitArrayUtilities ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static vtkSmartPointer< vtkDataArrayMCArrayToVTKArrayImpl (const conduit_node *mcarray, bool force_signed)
 
static vtkSmartPointer< vtkDataArrayMCArrayToVTKAOSArray (const conduit_node *mcarray, bool force_signed)
 
static vtkSmartPointer< vtkDataArrayMCArrayToVTKSOAArray (const conduit_node *mcarray, bool force_signed)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper to convert Conduit arrays to VTK arrays.

vtkConduitArrayUtilities is intended to convert Conduit nodes satisfying the mcarray protocol to VTK arrays. It uses zero-copy, as much as possible. Currently implementation fails if zero-copy is not possible. In future, that may be changed to do a deep-copy (with appropriate warnings) if necessary.

This is primarily designed for use by vtkConduitSource.

Definition at line 43 of file vtkConduitArrayUtilities.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkConduitArrayUtilities.h.

Constructor & Destructor Documentation

◆ vtkConduitArrayUtilities()

vtkConduitArrayUtilities::vtkConduitArrayUtilities ( )
protected

◆ ~vtkConduitArrayUtilities()

vtkConduitArrayUtilities::~vtkConduitArrayUtilities ( )
protected

Member Function Documentation

◆ New()

static vtkConduitArrayUtilities* vtkConduitArrayUtilities::New ( )
static

◆ GetClassName()

virtual const char* vtkConduitArrayUtilities::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkConduitArrayUtilities::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkConduitArrayUtilities::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkConduitArrayUtilities* vtkConduitArrayUtilities::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkConduitArrayUtilities::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ MCArrayToVTKArray() [1/2]

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::MCArrayToVTKArray ( const conduit_node mcarray)
static

Returns a vtkDataArray from a conduit node in the conduit mcarray protocol.

◆ MCArrayToVTKArray() [2/2]

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::MCArrayToVTKArray ( const conduit_node mcarray,
const std::string arrayname 
)
static

Returns a vtkDataArray from a conduit node in the conduit mcarray protocol.

◆ MCArrayToVTKCellArray()

static vtkSmartPointer<vtkCellArray> vtkConduitArrayUtilities::MCArrayToVTKCellArray ( vtkIdType  cellSize,
const conduit_node mcarray 
)
static

Converts an mcarray to vtkCellArray.

This may reinterpret unsigned array as signed arrays to avoid deep-copying of data to match data type expected by vtkCellArray API.

◆ SetNumberOfComponents()

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::SetNumberOfComponents ( vtkDataArray array,
int  num_components 
)
static

If the number of components in the array does not match the target, a new array is created.

◆ MCArrayToVTKArrayImpl()

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::MCArrayToVTKArrayImpl ( const conduit_node mcarray,
bool  force_signed 
)
staticprotected

◆ MCArrayToVTKAOSArray()

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::MCArrayToVTKAOSArray ( const conduit_node mcarray,
bool  force_signed 
)
staticprotected

◆ MCArrayToVTKSOAArray()

static vtkSmartPointer<vtkDataArray> vtkConduitArrayUtilities::MCArrayToVTKSOAArray ( const conduit_node mcarray,
bool  force_signed 
)
staticprotected

The documentation for this class was generated from the following file: