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 Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRInterfaceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
int EvalRcommand (const char *commandName, int param)
 Evaluate an R command on the embedded R interpreter that takes one integer argument. More...
 
int EvalRscript (const char *string, bool showRoutput=true)
 Evaluate an R script given in string on the embedded R interpreter. More...
 
int OutputBuffer (char *p, int n)
 Provide a character buffer in p of length n. More...
 
void AssignVTKDataArrayToRVariable (vtkDataArray *da, const char *RVariableName)
 Copies vtkDataArray da into the R interpreter instance as a variable named RVariableName. More...
 
void AssignVTKArrayToRVariable (vtkArray *da, const char *RVariableName)
 Copies vtkArray da into the R interpreter instance as a variable named RVariableName. More...
 
void AssignVTKTreeToRVariable (vtkTree *tr, const char *RVariableName)
 Copies vtkTree tr into the R interpreter instance as a variable named RVariableName. More...
 
vtkTreeAssignRVariableToVTKTree (const char *RVariableName)
 Copies the R variable RVariableName to the returned vtkDataArray. More...
 
vtkDataArrayAssignRVariableToVTKDataArray (const char *RVariableName)
 Copies the R variable RVariableName to the returned vtkDataArray. More...
 
vtkArrayAssignRVariableToVTKArray (const char *RVariableName)
 Copies the R variable RVariableName to the returned vtkArray. More...
 
vtkTableAssignRVariableToVTKTable (const char *RVariableName)
 Copies the R matrix or R list in RVariableName to the returned vtkTable. More...
 
void AssignVTKTableToRVariable (vtkTable *table, const char *RVariableName)
 Copies the vtkTable given in table to an R list structure name RVariableName. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkRInterfaceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRInterfaceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRInterface ()
 
 ~vtkRInterface ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods allow a command to exclusively grab all events. More...
 
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 59 of file vtkRInterface.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkRInterface.h.

Constructor & Destructor Documentation

◆ vtkRInterface()

vtkRInterface::vtkRInterface ( )
protected

◆ ~vtkRInterface()

vtkRInterface::~vtkRInterface ( )
protected

Member Function Documentation

◆ New()

static vtkRInterface* vtkRInterface::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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 vtkObjectBase.

◆ SafeDownCast()

static vtkRInterface* vtkRInterface::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRInterface::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRInterface* vtkRInterface::NewInstance ( ) const

◆ PrintSelf()

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.

◆ EvalRcommand()

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

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

◆ EvalRscript()

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.

◆ OutputBuffer()

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.

◆ AssignVTKDataArrayToRVariable()

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.

◆ AssignVTKArrayToRVariable()

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.

◆ AssignVTKTreeToRVariable()

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.

◆ AssignRVariableToVTKTree()

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

Copies the R variable RVariableName to the returned vtkDataArray.

If the operation fails, the method will return NULL.

◆ AssignRVariableToVTKDataArray()

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

Copies the R variable RVariableName to the returned vtkDataArray.

If the operation fails, the method will return NULL.

◆ AssignRVariableToVTKArray()

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.

◆ AssignRVariableToVTKTable()

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.

◆ AssignVTKTableToRVariable()

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: