#include <vtkMatlabEngineInterface.h>

Inheritance diagram for vtkMatlabEngineInterface:

Collaboration diagram for vtkMatlabEngineInterface:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () 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)

vtkCommand *	GetCommand (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 vtkMatlabEngineInterface *	New ()

static int	IsTypeOf (const char *type)

static vtkMatlabEngineInterface *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMatlabEngineInterface ()

	~vtkMatlabEngineInterface ()

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

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

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

static

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

virtual vtkObjectBase* vtkMatlabEngineInterface::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkMatlabEngineInterface* vtkMatlabEngineInterface::NewInstance ( ) const

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Matlab/vtkMatlabEngineInterface.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation