vtkMatlabEngineInterface Class Reference

#include <vtkMatlabEngineInterface.h>

Inheritance diagram for vtkMatlabEngineInterface:

Collaboration diagram for vtkMatlabEngineInterface:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkMatlabEngineInterface *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	EngineOpen ()
int	EvalString (const char *string)
int	PutVtkDataArray (const char *name, vtkDataArray *vda)
vtkDataArray *	GetVtkDataArray (const char *name)
int	PutVtkArray (const char *name, vtkArray *vda)
vtkArray *	GetVtkArray (const char *name)
int	OutputBuffer (char *p, int n)
int	SetVisibleOn ()
int	SetVisibleOff ()
Static Public Member Functions
static vtkMatlabEngineInterface *	New ()
static int	IsTypeOf (const char *type)
static vtkMatlabEngineInterface *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMatlabEngineInterface ()
	~vtkMatlabEngineInterface ()

---

Detailed Description

This class defines a VTK inteface to the MathWorks Matlab Engine.

When an instance of this class is created, a Matlab engine process is created as a singleton instance. Multiple instances of this interface can be created to access the Matlab engine singleton. The Matlab engine process is closed when all interface instances using it have been deleted.

The current implementation performs deep copies of all VTK data arrays passed to and from the Matlab Engine.

See also:

vtkMatlabMexAdapter vtkMatlabEngineFilter

Thanks:

Developed by Thomas Otahal at Sandia National Laboratories.

Examples:

vtkMatlabEngineInterface (Examples)

Tests:

vtkMatlabEngineInterface (Tests)

Definition at line 60 of file vtkMatlabEngineInterface.h.

---

Member Typedef Documentation

typedef vtkObject vtkMatlabEngineInterface::Superclass

Reimplemented from vtkObject.

Definition at line 67 of file vtkMatlabEngineInterface.h.

---

Constructor & Destructor Documentation

vtkMatlabEngineInterface::vtkMatlabEngineInterface

(

)

[protected]

vtkMatlabEngineInterface::~vtkMatlabEngineInterface

(

)

[protected]

---

Member Function Documentation

static vtkMatlabEngineInterface* vtkMatlabEngineInterface::New

(

)

[static]

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

Reimplemented from vtkObject.

static int vtkMatlabEngineInterface::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 vtkMatlabEngineInterface::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 vtkMatlabEngineInterface* vtkMatlabEngineInterface::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkMatlabEngineInterface::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkMatlabEngineInterface* vtkMatlabEngineInterface::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkMatlabEngineInterface::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 vtkMatlabEngineInterface::EngineOpen

(

)

Non zero if Matlab engine connection is open.

int vtkMatlabEngineInterface::EvalString

(

const char *

string

)

Input char string is a Matlab command or a series of Matlab commands read from an input file. Returns 0 if command failed to execute.

int vtkMatlabEngineInterface::PutVtkDataArray	(	const char *	name,
		vtkDataArray *	vda
	)

Send input vtkDataArray vda to the Matlab Engine as Matlab variable named name Returns 0 if variable was not created.

vtkDataArray* vtkMatlabEngineInterface::GetVtkDataArray

(

const char *

name

)

Get Matlab variable name from Matlab Engine and return as vtkDataArray (memory allocated) Returns 0 if variable could not be copied.

int vtkMatlabEngineInterface::PutVtkArray	(	const char *	name,
		vtkArray *	vda
	)

Send input vtkArray vda to the Matlab Engine as Matlab variable named name Returns 0 if variable was not created.

vtkArray* vtkMatlabEngineInterface::GetVtkArray

(

const char *

name

)

Get Matlab variable name from Matlab Engine and return as vtkArray (memory allocated) Returns 0 if variable could not be copied.

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

Use char buffer p of length n to store console output from the Matlab Engine. buffer is filled after each call to EvalString().

int vtkMatlabEngineInterface::SetVisibleOn

(

)

Turns the Matlab Engine process visible, so users can interact directly with Matlab.

int vtkMatlabEngineInterface::SetVisibleOff

(

)

Turns visibility off.

---

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

• /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Filters/Matlab/vtkMatlabEngineInterface.h