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

#include <vtkMatlabEngineInterface.h>

Inheritance diagram for vtkMatlabEngineInterface:

Collaboration diagram for vtkMatlabEngineInterface:

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

vtkMatlabEngineInterface *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

int	EngineOpen ()
	Non zero if Matlab engine connection is open. More...

int	EvalString (const char *string)
	Input char string is a Matlab command or a series of Matlab commands read from an input file. More...

int	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. More...

vtkDataArray *	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. More...

int	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. More...

vtkArray *	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. More...

int	OutputBuffer (char *p, int n)
	Use char buffer p of length n to store console output from the Matlab Engine. More...

int	SetVisibleOn ()
	Turns the Matlab Engine process visible, so users can interact directly with Matlab. More...

int	SetVisibleOff ()
	Turns visibility off. 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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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 vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMatlabEngineInterface ()

	~vtkMatlabEngineInterface ()

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 ()
	These methods allow a command to exclusively grab all events. More...

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 61 of file vtkMatlabEngineInterface.h.

Member Typedef Documentation

typedef vtkObject vtkMatlabEngineInterface::Superclass

Definition at line 68 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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkMatlabEngineInterface::NewInstanceInternal ( ) const

protectedvirtual

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/demarle/Builds/VTK/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