vtkRISReader Class Reference

#include <vtkRISReader.h>

Inheritance diagram for vtkRISReader:

Inheritance graph
[legend]
Collaboration diagram for vtkRISReader:

Collaboration graph
[legend]

List of all members.


Detailed Description

reader for RIS files

RIS is a tagged format for expressing bibliographic citations. Data is structured as a collection of records with each record composed of one-to-many fields. See

http://en.wikipedia.org/wiki/RIS_(file_format) http://www.refman.com/support/risformat_intro.asp http://www.adeptscience.co.uk/kb/article/A626

for details. vtkRISReader will convert an RIS file into a vtkTable, with the set of table columns determined dynamically from the contents of the file.

Events:
vtkCommand::ProgressEvent
Tests:
vtkRISReader (Tests)

Definition at line 50 of file vtkRISReader.h.


Public Types

typedef vtkTableAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual char * GetFileName ()
virtual void SetFileName (const char *)
virtual char * GetDelimiter ()
virtual void SetDelimiter (const char *)
virtual int GetMaxRecords ()
virtual void SetMaxRecords (int)

Static Public Member Functions

static vtkRISReaderNew ()
static int IsTypeOf (const char *type)
static vtkRISReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkRISReader ()
 ~vtkRISReader ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * FileName
char * Delimiter
int MaxRecords

Member Typedef Documentation

Reimplemented from vtkTableAlgorithm.

Definition at line 54 of file vtkRISReader.h.


Constructor & Destructor Documentation

vtkRISReader::vtkRISReader (  )  [protected]

vtkRISReader::~vtkRISReader (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkTableAlgorithm.

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

Reimplemented from vtkTableAlgorithm.

static int vtkRISReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

virtual int vtkRISReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

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

Reimplemented from vtkTableAlgorithm.

void vtkRISReader::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 vtkTableAlgorithm.

virtual char* vtkRISReader::GetFileName (  )  [virtual]

Set/get the file to load

virtual void vtkRISReader::SetFileName ( const char *   )  [virtual]

Set/get the file to load

virtual char* vtkRISReader::GetDelimiter (  )  [virtual]

Set/get the delimiter to be used for concatenating field data (default: ";")

virtual void vtkRISReader::SetDelimiter ( const char *   )  [virtual]

Set/get the delimiter to be used for concatenating field data (default: ";")

virtual int vtkRISReader::GetMaxRecords (  )  [virtual]

Set/get the maximum number of records to read from the file (zero = unlimited)

virtual void vtkRISReader::SetMaxRecords ( int   )  [virtual]

Set/get the maximum number of records to read from the file (zero = unlimited)

int vtkRISReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTableAlgorithm.


Member Data Documentation

char* vtkRISReader::FileName [protected]

Definition at line 86 of file vtkRISReader.h.

char* vtkRISReader::Delimiter [protected]

Definition at line 87 of file vtkRISReader.h.

int vtkRISReader::MaxRecords [protected]

Definition at line 88 of file vtkRISReader.h.


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

Generated on Sat Dec 27 13:48:05 2008 for VTK by  doxygen 1.5.6