vtkRAdapter Class Reference

#include <vtkRAdapter.h>

Inheritance diagram for vtkRAdapter:

[legend]

Collaboration diagram for vtkRAdapter:

[legend]

List of all members.

---

Detailed Description

This is a utility class to convert VTK array data and VTK tables to and from Gnu R S expression (SEXP) data structures. It is used with the R .Call interface and the embedded R interpreter.

This class creates deep copies of input data. Created R SEXP variables created by these functions can be freed by the R garbage collector by calling UNPROTECT(1). The conversions are performed for double and integer data types.

VTK data structures created by this class from R types are stored in array collections and freed when the class destructor is called. Use the Register() method on a returned object to increase its reference count by one, in order keep the object around after this classes destructor has been called. The code calling Register() must eventually call Delete() on the object to free memory.

See also:

vtkRinterface vtkRcalculatorFilter

Thanks:

Developed by Thomas Otahal at Sandia National Laboratories.

Definition at line 62 of file vtkRAdapter.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkDataArray *	RToVTKDataArray (SEXP variable)
vtkArray *	RToVTKArray (SEXP variable)
SEXP	VTKDataArrayToR (vtkDataArray *da)
SEXP	VTKArrayToR (vtkArray *da)
SEXP	VTKTableToR (vtkTable *table)
vtkTable *	RToVTKTable (SEXP variable)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkRAdapter *	SafeDownCast (vtkObject *o)
static vtkRAdapter *	New ()
Protected Member Functions
	vtkRAdapter ()
	~vtkRAdapter ()

---

Member Typedef Documentation

typedef vtkObject vtkRAdapter::Superclass

Reimplemented from vtkObject.

Definition at line 67 of file vtkRAdapter.h.

---

Constructor & Destructor Documentation

vtkRAdapter::vtkRAdapter

(

)

[protected]

vtkRAdapter::~vtkRAdapter

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkRAdapter::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkRAdapter::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkRAdapter::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkRAdapter* vtkRAdapter::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkRAdapter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkRAdapter* vtkRAdapter::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

vtkDataArray* vtkRAdapter::RToVTKDataArray

(

SEXP

variable

)

Create a vtkDataArray copy of GNU R input matrix vaiable (deep copy, allocates memory) Input is a R matrix or vector of doubles or integers

vtkArray* vtkRAdapter::RToVTKArray

(

SEXP

variable

)

Create a vtkArray copy of the GNU R input variable multi-dimensional array (deep copy, allocates memory) Input is a R multi-dimensional array of doubles or integers

SEXP vtkRAdapter::VTKDataArrayToR

(

vtkDataArray *

da

)

Create a GNU R matrix copy of the input vtkDataArray da (deep copy, allocates memory)

SEXP vtkRAdapter::VTKArrayToR

(

vtkArray *

da

)

Create a GNU R multi-dimensional array copy of the input vtkArray da (deep copy, allocates memory)

SEXP vtkRAdapter::VTKTableToR

(

vtkTable *

table

)

Create a GNU R matrix copy of the input vtkTable table (deep copy, allocates memory)

vtkTable* vtkRAdapter::RToVTKTable

(

SEXP

variable

)

Create a vtkTable copy of the GNU R input matrix variable (deep copy, allocates memory) Input is R list of equal length vectors or a matrix.

---

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

• dox/Graphics/vtkRAdapter.h