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

#include <vtkRInterface.h>

Inheritance diagram for vtkRInterface:
[legend]
Collaboration diagram for vtkRInterface:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRInterfaceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int EvalRcommand (const char *commandName, int param)
 
int EvalRscript (const char *string, bool showRoutput=true)
 
int OutputBuffer (char *p, int n)
 
void AssignVTKDataArrayToRVariable (vtkDataArray *da, const char *RVariableName)
 
void AssignVTKArrayToRVariable (vtkArray *da, const char *RVariableName)
 
void AssignVTKTreeToRVariable (vtkTree *tr, const char *RVariableName)
 
vtkTreeAssignRVariableToVTKTree (const char *RVariableName)
 
vtkDataArrayAssignRVariableToVTKDataArray (const char *RVariableName)
 
vtkArrayAssignRVariableToVTKArray (const char *RVariableName)
 
vtkTableAssignRVariableToVTKTable (const char *RVariableName)
 
void AssignVTKTableToRVariable (vtkTable *table, const char *RVariableName)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
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 *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkRInterfaceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRInterfaceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRInterface ()
 
 ~vtkRInterface ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
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 &)
 

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

This class defines a VTK interface to an embedded GNU R intepreter instance. An instance of the R interpreter is created when this class is instantiated. Additional instances of this class will share access the same R interpreter. The R interpreter will be shutdown when the application using this class exits.

See also
vtkRadapter vtkRcalculatorFilter
Thanks:
Developed by Thomas Otahal at Sandia National Laboratories.
Examples:
vtkRInterface (Examples)
Tests:
vtkRInterface (Tests)

Definition at line 58 of file vtkRInterface.h.

Member Typedef Documentation

Definition at line 63 of file vtkRInterface.h.

Constructor & Destructor Documentation

vtkRInterface::vtkRInterface ( )
protected
vtkRInterface::~vtkRInterface ( )
protected

Member Function Documentation

static vtkRInterface* vtkRInterface::New ( )
static
static int vtkRInterface::IsTypeOf ( const char *  type)
static
virtual int vtkRInterface::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 vtkRInterface* vtkRInterface::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkRInterface::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkRInterface* vtkRInterface::NewInstance ( ) const
void vtkRInterface::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.

int vtkRInterface::EvalRcommand ( const char *  commandName,
int  param 
)

Evaluate an R command on the embedded R interpreter that takes one integer argument.

int vtkRInterface::EvalRscript ( const char *  string,
bool  showRoutput = true 
)

Evaluate an R script given in string on the embedded R interpreter. Set showRoutput to turn on and off output from R.

int vtkRInterface::OutputBuffer ( char *  p,
int  n 
)

Provide a character buffer in p of length n. All output from the R interpreter instance will be written to p by default.

void vtkRInterface::AssignVTKDataArrayToRVariable ( vtkDataArray da,
const char *  RVariableName 
)

Copies vtkDataArray da into the R interpreter instance as a variable named RVariableName. If RVariableName already exists, it will be overwritten.

void vtkRInterface::AssignVTKArrayToRVariable ( vtkArray da,
const char *  RVariableName 
)

Copies vtkArray da into the R interpreter instance as a variable named RVariableName. If RVariableName already exists, it will be overwritten.

void vtkRInterface::AssignVTKTreeToRVariable ( vtkTree tr,
const char *  RVariableName 
)

Copies vtkTree tr into the R interpreter instance as a variable named RVariableName. If RVariableName already exists, it will be overwritten.

vtkTree* vtkRInterface::AssignRVariableToVTKTree ( const char *  RVariableName)

Copies the R variable RVariableName to the returned vtkDataArray. If the operation fails, the method will return NULL.

vtkDataArray* vtkRInterface::AssignRVariableToVTKDataArray ( const char *  RVariableName)

Copies the R variable RVariableName to the returned vtkDataArray. If the operation fails, the method will return NULL.

vtkArray* vtkRInterface::AssignRVariableToVTKArray ( const char *  RVariableName)

Copies the R variable RVariableName to the returned vtkArray. If the operation fails, the method will return NULL. The returned vtkArray is currently always a vtkDenseArray of type double.

vtkTable* vtkRInterface::AssignRVariableToVTKTable ( const char *  RVariableName)

Copies the R matrix or R list in RVariableName to the returned vtkTable. If the operation fails, the method will return NULL. If RVariableName is an R list, each list entry must be a vector of the same length.

void vtkRInterface::AssignVTKTableToRVariable ( vtkTable table,
const char *  RVariableName 
)

Copies the vtkTable given in table to an R list structure name RVariableName. The R list will be length of the number of columns in table. Each member of the list will contain a column of table.


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