VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkJavaScriptDataWriter Class Reference

A Javascript data writer for vtkTable Writes a vtkTable into a Javascript data format. More...

#include <vtkJavaScriptDataWriter.h>

Inheritance diagram for vtkJavaScriptDataWriter:
[legend]
Collaboration diagram for vtkJavaScriptDataWriter:
[legend]

List of all members.

Public Types

typedef vtkWriter Superclass
- Public Types inherited from vtkWriter
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetOutputStream (ostream *my_stream)
ostream * GetOutputStream ()
virtual void SetVariableName (const char *)
virtual char * GetVariableName ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetIncludeFieldNames (bool)
virtual bool GetIncludeFieldNames ()
- Public Member Functions inherited from vtkWriter
virtual int Write ()
void EncodeString (char *resname, const char *name, bool doublePercent)
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void SetInput (vtkDataObject *input)
void SetInput (int index, vtkDataObject *input)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(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)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkJavaScriptDataWriterNew ()
static int IsTypeOf (const char *type)
static vtkJavaScriptDataWriterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkJavaScriptDataWriter ()
 ~vtkJavaScriptDataWriter ()
ofstream * OpenFile ()
virtual void WriteData ()
virtual void WriteTable (vtkTable *table, ostream *stream_ptr)
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 ~vtkWriter ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- 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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

char * VariableName
char * FileName
bool IncludeFieldNames
ostream * OutputStream
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

A Javascript data writer for vtkTable Writes a vtkTable into a Javascript data format.

Definition at line 34 of file vtkJavaScriptDataWriter.h.


Member Typedef Documentation

Reimplemented from vtkWriter.

Definition at line 38 of file vtkJavaScriptDataWriter.h.


Constructor & Destructor Documentation

vtkJavaScriptDataWriter::vtkJavaScriptDataWriter ( )
protected
vtkJavaScriptDataWriter::~vtkJavaScriptDataWriter ( )
protected

Member Function Documentation

static vtkJavaScriptDataWriter* vtkJavaScriptDataWriter::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkJavaScriptDataWriter::GetClassName ( )
virtual

Reimplemented from vtkWriter.

static int vtkJavaScriptDataWriter::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 vtkWriter.

virtual int vtkJavaScriptDataWriter::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 vtkWriter.

static vtkJavaScriptDataWriter* vtkJavaScriptDataWriter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkWriter.

void vtkJavaScriptDataWriter::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 vtkWriter.

virtual void vtkJavaScriptDataWriter::SetVariableName ( const char *  )
virtual

Get/set the name of the Javascript variable that the dataset will be assigned to. The default value is "data", so the javascript code generated by the filter will look like this: "var data = [ ... ];". If VariableName is set to NULL, then no assignment statement will be generated (i.e., only "[ ... ];" will be generated).

virtual char* vtkJavaScriptDataWriter::GetVariableName ( )
virtual

Get/set the name of the Javascript variable that the dataset will be assigned to. The default value is "data", so the javascript code generated by the filter will look like this: "var data = [ ... ];". If VariableName is set to NULL, then no assignment statement will be generated (i.e., only "[ ... ];" will be generated).

virtual void vtkJavaScriptDataWriter::SetFileName ( const char *  )
virtual

Get/Set the filename for the file.

virtual char* vtkJavaScriptDataWriter::GetFileName ( )
virtual

Get/Set the filename for the file.

virtual void vtkJavaScriptDataWriter::SetIncludeFieldNames ( bool  )
virtual

Get/Set the whether or not to include field names When field names are on you will get data output that looks like this: var data=[ {foo:3,time:"2009-11-04 16:09:42",bar:1 }, {foo:5,time:"2009-11-04 16:11:22",bar:0 }, without field names the data will be an array of arrays like this: var data=[ [3,"2009-11-04 16:09:42",1], [5,"2009-11-04 16:11:22",0], Default is ON (true)

virtual bool vtkJavaScriptDataWriter::GetIncludeFieldNames ( )
virtual

Get/Set the whether or not to include field names When field names are on you will get data output that looks like this: var data=[ {foo:3,time:"2009-11-04 16:09:42",bar:1 }, {foo:5,time:"2009-11-04 16:11:22",bar:0 }, without field names the data will be an array of arrays like this: var data=[ [3,"2009-11-04 16:09:42",1], [5,"2009-11-04 16:11:22",0], Default is ON (true)

void vtkJavaScriptDataWriter::SetOutputStream ( ostream *  my_stream)
ostream* vtkJavaScriptDataWriter::GetOutputStream ( )
ofstream* vtkJavaScriptDataWriter::OpenFile ( )
protected
virtual void vtkJavaScriptDataWriter::WriteData ( )
protectedvirtual

Implements vtkWriter.

virtual void vtkJavaScriptDataWriter::WriteTable ( vtkTable table,
ostream *  stream_ptr 
)
protectedvirtual
virtual int vtkJavaScriptDataWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


Member Data Documentation

char* vtkJavaScriptDataWriter::VariableName
protected

Definition at line 85 of file vtkJavaScriptDataWriter.h.

char* vtkJavaScriptDataWriter::FileName
protected

Definition at line 86 of file vtkJavaScriptDataWriter.h.

bool vtkJavaScriptDataWriter::IncludeFieldNames
protected

Definition at line 87 of file vtkJavaScriptDataWriter.h.

ostream* vtkJavaScriptDataWriter::OutputStream
protected

Definition at line 88 of file vtkJavaScriptDataWriter.h.


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