vtkImageReader2Factory Class Reference

Superclass of binary file readers. More...

#include <vtkImageReader2Factory.h>

Inheritance diagram for vtkImageReader2Factory:

Collaboration diagram for vtkImageReader2Factory:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkImageReader2Factory *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkImageReader2Factory *	New ()
static int	IsTypeOf (const char *type)
static vtkImageReader2Factory *	SafeDownCast (vtkObjectBase *o)
static void	RegisterReader (vtkImageReader2 *r)
static vtkImageReader2 *	CreateImageReader2 (const char *path)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
Static Protected Member Functions
static void	InitializeReaders ()
Friends
class	vtkImageReader2FactoryCleanup
static void	GetRegisteredReaders (vtkImageReader2Collection *)
	vtkImageReader2Factory ()
	~vtkImageReader2Factory ()

---

Detailed Description

Superclass of binary file readers.

vtkImageReader2Factory: This class is used to create a vtkImageReader2 object given a path name to a file. It calls CanReadFile on all available readers until one of them returns true. The available reader list comes from three places. In the InitializeReaders function of this class, built-in VTK classes are added to the list, users can call RegisterReader, or users can create a vtkObjectFactory that has CreateObject method that returns a new vtkImageReader2 sub class when given the string "vtkImageReaderObject". This way applications can be extended with new readers via a plugin dll or by calling RegisterReader. Of course all of the readers that are part of the vtk release are made automatically available.

See also:

vtkImageReader2

Examples:

vtkImageReader2Factory (Examples)

Tests:

vtkImageReader2Factory (Tests)

Definition at line 51 of file vtkImageReader2Factory.h.

---

Member Typedef Documentation

typedef vtkObject vtkImageReader2Factory::Superclass

Reimplemented from vtkObject.

Definition at line 55 of file vtkImageReader2Factory.h.

---

Constructor & Destructor Documentation

vtkImageReader2Factory::vtkImageReader2Factory

(

)

[protected]

The caller must allocate the vtkImageReader2Collection and pass in the pointer to this method.

vtkImageReader2Factory::~vtkImageReader2Factory

(

)

[protected]

The caller must allocate the vtkImageReader2Collection and pass in the pointer to this method.

---

Member Function Documentation

static vtkImageReader2Factory* vtkImageReader2Factory::New

(

)

[static]

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

Reimplemented from vtkObject.

static int vtkImageReader2Factory::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 vtkObject.

virtual int vtkImageReader2Factory::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 vtkImageReader2Factory* vtkImageReader2Factory::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkImageReader2Factory::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkImageReader2Factory* vtkImageReader2Factory::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkImageReader2Factory::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.

static void vtkImageReader2Factory::RegisterReader

(

vtkImageReader2 *

r

)

[static]

registered readers will be queried in CreateImageReader2 to see if they can load a given file.

static vtkImageReader2* vtkImageReader2Factory::CreateImageReader2

(

const char *

path

)

[static]

open the image file, it is the callers responsibility to call Delete on the returned object. If no reader is found, null is returned.

static void vtkImageReader2Factory::GetRegisteredReaders

(

vtkImageReader2Collection *

)

[static]

The caller must allocate the vtkImageReader2Collection and pass in the pointer to this method.

static void vtkImageReader2Factory::InitializeReaders

(

)

[static, protected]

---

Friends And Related Function Documentation

friend class vtkImageReader2FactoryCleanup [friend]

Definition at line 82 of file vtkImageReader2Factory.h.

---

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

• dox/IO/Image/vtkImageReader2Factory.h