<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VTK: vtkImageReader2Factory Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>vtkImageReader2Factory Class Reference</h1><!-- doxytag: class="vtkImageReader2Factory" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a04928.html">vtkImageReader2Factory.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkImageReader2Factory:</div> <div class="dynsection"> <p><center><img src="a11121.png" border="0" usemap="#a11122" alt="Inheritance graph"></center> <map name="a11122"> <area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="54,80,134,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="39,6,148,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkImageReader2Factory:</div> <div class="dynsection"> <p><center><img src="a11123.png" border="0" usemap="#a11124" alt="Collaboration graph"></center> <map name="a11124"> <area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="158,309,259,336"><area shape="rect" href="a00286.html" title="vtkCollectionElement" alt="" coords="164,187,314,213"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="6,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"><area shape="rect" href="a00816.html" title="maintain a list of image readers" alt="" coords="114,387,303,413"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="a11125.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Superclass of binary file readers. <p> <a class="el" href="a00817.html" title="Superclass of binary file readers.">vtkImageReader2Factory</a>: This class is used to create a <a class="el" href="a00815.html" title="Superclass of binary file readers.">vtkImageReader2</a> 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 <a class="el" href="a01086.html" title="abstract base class for vtkObjectFactories">vtkObjectFactory</a> that has CreateObject method that returns a new <a class="el" href="a00815.html" title="Superclass of binary file readers.">vtkImageReader2</a> 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.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00815.html" title="Superclass of binary file readers.">vtkImageReader2</a></dd></dl> <dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_8.html#c2_vtk_t_vtkImageReader2Factory">vtkImageReader2Factory (Tests)</a> </dd></dl> <p>Definition at line <a class="el" href="a04928.html#l00047">47</a> of file <a class="el" href="a04928.html">vtkImageReader2Factory.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01084.html">vtkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#77b16e3ea66b8a3c9f70c6914b5a59b0">Superclass</a></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#6555ba6fd1bef9d908e6072188892234">GetClassName</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#42333b42b758649d606ebdb0f8bd0724">IsA</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#3ee735d4b09e78f706ebe0c194083a37">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00817.html">vtkImageReader2Factory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#330a3894ed6256f43d237c0575e6bd96">New</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#06a2b5ad4d7a689539889074ce18514d">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00817.html">vtkImageReader2Factory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#3acd94a8d8e7b96e32c697cec343c1fc">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#b1cb191117fa8da4d04ce67ab5464d0e">RegisterReader</a> (<a class="el" href="a00815.html">vtkImageReader2</a> *r)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00815.html">vtkImageReader2</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#f73e2561d82dbcb35aa710ecf7e5a518">CreateImageReader2</a> (const char *path)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#4973942e0335d41aa28e5dcc4568899c">GetRegisteredReaders</a> (<a class="el" href="a00816.html">vtkImageReader2Collection</a> *)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#c159c590f6167f08af963ecc5d4611e2">vtkImageReader2Factory</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#dee7851394e665be0a837d8b3a67e388">~vtkImageReader2Factory</a> ()</td></tr> <tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#370c6e7222ac2b103c4cec5164e69021">InitializeReaders</a> ()</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00817.html#6dde6d3f40ebfe94dbc724ff2153f8a0">vtkImageReader2FactoryCleanup</a></td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="77b16e3ea66b8a3c9f70c6914b5a59b0"></a><!-- doxytag: member="vtkImageReader2Factory::Superclass" ref="77b16e3ea66b8a3c9f70c6914b5a59b0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkImageReader2Factory::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p> <p>Definition at line <a class="el" href="a04928.html#l00051">51</a> of file <a class="el" href="a04928.html">vtkImageReader2Factory.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="c159c590f6167f08af963ecc5d4611e2"></a><!-- doxytag: member="vtkImageReader2Factory::vtkImageReader2Factory" ref="c159c590f6167f08af963ecc5d4611e2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkImageReader2Factory::vtkImageReader2Factory </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="dee7851394e665be0a837d8b3a67e388"></a><!-- doxytag: member="vtkImageReader2Factory::~vtkImageReader2Factory" ref="dee7851394e665be0a837d8b3a67e388" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkImageReader2Factory::~vtkImageReader2Factory </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="330a3894ed6256f43d237c0575e6bd96"></a><!-- doxytag: member="vtkImageReader2Factory::New" ref="330a3894ed6256f43d237c0575e6bd96" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00817.html">vtkImageReader2Factory</a>* vtkImageReader2Factory::New </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an object with Debug turned off, modified time initialized to zero, and reference counting on. <p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="6555ba6fd1bef9d908e6072188892234"></a><!-- doxytag: member="vtkImageReader2Factory::GetClassName" ref="6555ba6fd1bef9d908e6072188892234" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkImageReader2Factory::GetClassName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="06a2b5ad4d7a689539889074ce18514d"></a><!-- doxytag: member="vtkImageReader2Factory::IsTypeOf" ref="06a2b5ad4d7a689539889074ce18514d" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkImageReader2Factory::IsTypeOf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> 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. <p>Reimplemented from <a class="el" href="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="42333b42b758649d606ebdb0f8bd0724"></a><!-- doxytag: member="vtkImageReader2Factory::IsA" ref="42333b42b758649d606ebdb0f8bd0724" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkImageReader2Factory::IsA </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> 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. <p>Reimplemented from <a class="el" href="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="3acd94a8d8e7b96e32c697cec343c1fc"></a><!-- doxytag: member="vtkImageReader2Factory::SafeDownCast" ref="3acd94a8d8e7b96e32c697cec343c1fc" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00817.html">vtkImageReader2Factory</a>* vtkImageReader2Factory::SafeDownCast </td> <td>(</td> <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="3ee735d4b09e78f706ebe0c194083a37"></a><!-- doxytag: member="vtkImageReader2Factory::PrintSelf" ref="3ee735d4b09e78f706ebe0c194083a37" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkImageReader2Factory::PrintSelf </td> <td>(</td> <td class="paramtype">ostream & </td> <td class="paramname"> <em>os</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td> <td class="paramname"> <em>indent</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. <p>Reimplemented from <a class="el" href="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p> </div> </div><p> <a class="anchor" name="b1cb191117fa8da4d04ce67ab5464d0e"></a><!-- doxytag: member="vtkImageReader2Factory::RegisterReader" ref="b1cb191117fa8da4d04ce67ab5464d0e" args="(vtkImageReader2 *r)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void vtkImageReader2Factory::RegisterReader </td> <td>(</td> <td class="paramtype"><a class="el" href="a00815.html">vtkImageReader2</a> * </td> <td class="paramname"> <em>r</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> registered readers will be queried in CreateImageReader2 to see if they can load a given file. </div> </div><p> <a class="anchor" name="f73e2561d82dbcb35aa710ecf7e5a518"></a><!-- doxytag: member="vtkImageReader2Factory::CreateImageReader2" ref="f73e2561d82dbcb35aa710ecf7e5a518" args="(const char *path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a00815.html">vtkImageReader2</a>* vtkImageReader2Factory::CreateImageReader2 </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>path</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> open the image file, it is the callers responsibility to call Delete on the returned object. If no reader is found, null is returned. </div> </div><p> <a class="anchor" name="4973942e0335d41aa28e5dcc4568899c"></a><!-- doxytag: member="vtkImageReader2Factory::GetRegisteredReaders" ref="4973942e0335d41aa28e5dcc4568899c" args="(vtkImageReader2Collection *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void vtkImageReader2Factory::GetRegisteredReaders </td> <td>(</td> <td class="paramtype"><a class="el" href="a00816.html">vtkImageReader2Collection</a> * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The caller must allocate the <a class="el" href="a00816.html" title="maintain a list of image readers">vtkImageReader2Collection</a> and pass in the pointer to this method. </div> </div><p> <a class="anchor" name="370c6e7222ac2b103c4cec5164e69021"></a><!-- doxytag: member="vtkImageReader2Factory::InitializeReaders" ref="370c6e7222ac2b103c4cec5164e69021" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void vtkImageReader2Factory::InitializeReaders </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="6dde6d3f40ebfe94dbc724ff2153f8a0"></a><!-- doxytag: member="vtkImageReader2Factory::vtkImageReader2FactoryCleanup" ref="6dde6d3f40ebfe94dbc724ff2153f8a0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class vtkImageReader2FactoryCleanup<code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="a04928.html#l00076">76</a> of file <a class="el" href="a04928.html">vtkImageReader2Factory.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/IO/<a class="el" href="a04928.html">vtkImageReader2Factory.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:10:43 2009 for VTK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>