vtkProgrammableDataObjectSource Class Reference

#include <vtkProgrammableDataObjectSource.h>

Inheritance diagram for vtkProgrammableDataObjectSource:

Inheritance graph
Collaboration diagram for vtkProgrammableDataObjectSource:

Collaboration graph

List of all members.

Detailed Description

generate source data object via a user-specified function

vtkProgrammableDataObjectSource is a source object that is programmable by the user. The output of the filter is a data object (vtkDataObject) which represents data via an instance of field data. To use this object, you must specify a function that creates the output.

Example use of this filter includes reading tabular data and encoding it as vtkFieldData. You can then use filters like vtkDataObjectToDataSetFilter to convert the data object to a dataset and then visualize it. Another important use of this class is that it allows users of interpreters (e.g., Tcl or Java) the ability to write source objects without having to recompile C++ code or generate new libraries.

See also:
vtkProgrammableFilter vtkProgrammableAttributeDataFilter vtkProgrammableSource vtkDataObjectToDataSetFilter
vtkProgrammableDataObjectSource (Examples)
vtkProgrammableDataObjectSource (Tests)

Definition at line 46 of file vtkProgrammableDataObjectSource.h.

Public Types

typedef vtkDataObjectAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetExecuteMethod (void(*f)(void *), void *arg)
void SetExecuteMethodArgDelete (void(*f)(void *))

Static Public Member Functions

New ()
static int IsTypeOf (const char *type)
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkProgrammableDataObjectSource ()
 ~vtkProgrammableDataObjectSource ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

void(* ExecuteMethod )(void *)
void(* ExecuteMethodArgDelete )(void *)
void * ExecuteMethodArg

Member Typedef Documentation

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 50 of file vtkProgrammableDataObjectSource.h.

Constructor & Destructor Documentation

vtkProgrammableDataObjectSource::vtkProgrammableDataObjectSource (  )  [protected]

vtkProgrammableDataObjectSource::~vtkProgrammableDataObjectSource (  )  [protected]

Member Function Documentation

static vtkProgrammableDataObjectSource* vtkProgrammableDataObjectSource::New (  )  [static]

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

Reimplemented from vtkDataObjectAlgorithm.

virtual const char* vtkProgrammableDataObjectSource::GetClassName (  )  [virtual]

Reimplemented from vtkDataObjectAlgorithm.

static int vtkProgrammableDataObjectSource::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 vtkDataObjectAlgorithm.

virtual int vtkProgrammableDataObjectSource::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 vtkDataObjectAlgorithm.

static vtkProgrammableDataObjectSource* vtkProgrammableDataObjectSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkDataObjectAlgorithm.

void vtkProgrammableDataObjectSource::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 vtkDataObjectAlgorithm.

void vtkProgrammableDataObjectSource::SetExecuteMethod ( void(*)(void *)  f,
void *  arg 

Specify the function to use to generate the output data object. Note that the function takes a single (void *) argument.

void vtkProgrammableDataObjectSource::SetExecuteMethodArgDelete ( void(*)(void *)  f  ) 

Set the arg delete method. This is used to free user memory.

virtual int vtkProgrammableDataObjectSource::RequestData ( vtkInformation ,
vtkInformationVector **  ,
) [protected, virtual]

Reimplemented from vtkDataObjectAlgorithm.

Member Data Documentation

Definition at line 69 of file vtkProgrammableDataObjectSource.h.

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

Generated on Mon Sep 27 18:43:08 2010 for VTK by  doxygen 1.5.6