<!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: vtkDataObjectSource 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>vtkDataObjectSource Class Reference</h1><!-- doxytag: class="vtkDataObjectSource" --><!-- doxytag: inherits="vtkSource" --><code>#include <<a class="el" href="a04014.html">vtkDataObjectSource.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkDataObjectSource:</div>
<div class="dynsection">
<p><center><img src="a09025.png" border="0" usemap="#a09026" alt="Inheritance graph"></center>
<map name="a09026">
<area shape="rect" href="a01574.html" title="abstract class specifies interface for visualization network source" alt="" coords="40,304,123,331"><area shape="rect" href="a01306.html" title="abstract class specifies interface for visualization filters" alt="" coords="18,230,146,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="32,155,131,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="42,80,122,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="27,6,136,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkDataObjectSource:</div>
<div class="dynsection">
<p><center><img src="a09027.png" border="0" usemap="#a09028" alt="Collaboration graph"></center>
<map name="a09028">
<area shape="rect" href="a01574.html" title="abstract class specifies interface for visualization network source" alt="" coords="1423,96,1505,123"><area shape="rect" href="a00362.html" title="general representation of visualization data" alt="" coords="1647,177,1753,204"><area shape="rect" href="a01306.html" title="abstract class specifies interface for visualization filters" alt="" coords="1863,177,1991,204"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="1056,389,1155,416"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="1415,299,1513,325"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="444,399,524,425"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="675,348,824,375"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="695,576,804,603"><area shape="rect" href="a00538.html" title="represent and manipulate fields of data" alt="" coords="1415,489,1513,516"><area shape="rect" href="a00081.html" title="Abstract superclass for all arrays." alt="" coords="1044,551,1167,577"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="7,519,116,545"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="403,565,565,592"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="169,580,300,607"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="180,96,289,123"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="393,616,575,643"><area shape="rect" href="a00540.html" title="vtkFieldData::CopyFieldFlag" alt="" coords="1008,500,1203,527"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a09029.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
abstract class specifies interface for field source (or objects that generate field output)
<p>
<a class="el" href="a00367.html" title="abstract class specifies interface for field source (or objects that generate field...">vtkDataObjectSource</a> is an abstract object that specifies behavior and interface of field source objects. Field source objects are source objects that create <a class="el" href="a00538.html" title="represent and manipulate fields of data">vtkFieldData</a> (field data) on output.<p>
Concrete subclasses of <a class="el" href="a00367.html" title="abstract class specifies interface for field source (or objects that generate field...">vtkDataObjectSource</a> must define <a class="el" href="a01574.html#35d01b232dd248861f41e84d8b1f7eed">Update()</a> and <a class="el" href="a01574.html#225fb8cb19e8087cbb8ee9fbb47f6a09">Execute()</a> methods. The public method <a class="el" href="a01574.html#35d01b232dd248861f41e84d8b1f7eed">Update()</a> invokes network execution and will bring the network up-to-date. The protected <a class="el" href="a01574.html#225fb8cb19e8087cbb8ee9fbb47f6a09">Execute()</a> method actually does the work of data creation/generation. The difference between the two methods is that <a class="el" href="a01574.html#35d01b232dd248861f41e84d8b1f7eed">Update()</a> implements input consistency checks and modified time comparisons and then invokes the <a class="el" href="a01574.html#225fb8cb19e8087cbb8ee9fbb47f6a09">Execute()</a> which is an implementation of a particular algorithm.<p>
<a class="el" href="a00367.html" title="abstract class specifies interface for field source (or objects that generate field...">vtkDataObjectSource</a> provides a mechanism for invoking the methods StartMethod() and EndMethod() before and after object execution (via <a class="el" href="a01574.html#225fb8cb19e8087cbb8ee9fbb47f6a09">Execute()</a>). These are convenience methods you can use for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.) These methods accept a single void* pointer that can be used to send data to the methods. It is also possible to specify a function to delete the argument via StartMethodArgDelete and EndMethodArgDelete.<p>
Another method, ProgressMethod() can be specified. Some filters invoke this method periodically during their execution. The use is similar to that of StartMethod() and EndMethod().<p>
An important feature of subclasses of <a class="el" href="a00367.html" title="abstract class specifies interface for field source (or objects that generate field...">vtkDataObjectSource</a> is that it is possible to control the memory-management model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01574.html" title="abstract class specifies interface for visualization network source">vtkSource</a> vtkFilter vtkFieldDataFilter </dd></dl>
<p>Definition at line <a class="el" href="a04014.html#l00061">61</a> of file <a class="el" href="a04014.html">vtkDataObjectSource.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="a01574.html">vtkSource</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#c809e0b58355f8628fa572deb8a7b7df">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="a00367.html#3bc4d8c632546ef65ebd8a373668585a">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="a00367.html#4e02b96a84cea701537c04d473c5b802">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="a00367.html#112649593d6f36a0677aca50f3f58e17">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#2a08fd9c24708a8aaa3211dad3ecd693">SetOutput</a> (<a class="el" href="a00362.html">vtkDataObject</a> *)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00362.html">vtkDataObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#1c91a944ec8f7c097274d7b0d42284f7">GetOutput</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00362.html">vtkDataObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#87272ee6ae07a3efb5f5803f06116070">GetOutput</a> (int idx)</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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#51eae738557fd95cb9f449da305d2098">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00367.html">vtkDataObjectSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#3b07b4ce0f08b5ac3ac6fa2686460b8e">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</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="a00367.html#a2c17bb0fb18db1ccda753cb233b183b">vtkDataObjectSource</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#13c032b0ef24ad7639d4b5c08f1b8c6e">~vtkDataObjectSource</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html#1b8d7d930d74b364cfe21571a2d7058d">FillOutputPortInformation</a> (int, <a class="el" href="a00872.html">vtkInformation</a> *)</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="c809e0b58355f8628fa572deb8a7b7df"></a><!-- doxytag: member="vtkDataObjectSource::Superclass" ref="c809e0b58355f8628fa572deb8a7b7df" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01574.html">vtkSource</a> <a class="el" href="a01574.html">vtkDataObjectSource::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01574.html#e38c81cb82d6a0bc5d0ac2b734b8cf4d">vtkSource</a>.</p>
<p>Definition at line <a class="el" href="a04014.html#l00064">64</a> of file <a class="el" href="a04014.html">vtkDataObjectSource.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a2c17bb0fb18db1ccda753cb233b183b"></a><!-- doxytag: member="vtkDataObjectSource::vtkDataObjectSource" ref="a2c17bb0fb18db1ccda753cb233b183b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkDataObjectSource::vtkDataObjectSource </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="13c032b0ef24ad7639d4b5c08f1b8c6e"></a><!-- doxytag: member="vtkDataObjectSource::~vtkDataObjectSource" ref="13c032b0ef24ad7639d4b5c08f1b8c6e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkDataObjectSource::~vtkDataObjectSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04014.html#l00080">80</a> of file <a class="el" href="a04014.html">vtkDataObjectSource.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3bc4d8c632546ef65ebd8a373668585a"></a><!-- doxytag: member="vtkDataObjectSource::GetClassName" ref="3bc4d8c632546ef65ebd8a373668585a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkDataObjectSource::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="a01574.html#6c6a912f2c5a75885d285b3ceee66adc">vtkSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="51eae738557fd95cb9f449da305d2098"></a><!-- doxytag: member="vtkDataObjectSource::IsTypeOf" ref="51eae738557fd95cb9f449da305d2098" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkDataObjectSource::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="a01574.html#df8b360ba6b51f1f975fec2a9f09593a">vtkSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e02b96a84cea701537c04d473c5b802"></a><!-- doxytag: member="vtkDataObjectSource::IsA" ref="4e02b96a84cea701537c04d473c5b802" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkDataObjectSource::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="a01574.html#2815f182e3e4fe43072fd6d0226f3e3d">vtkSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="3b07b4ce0f08b5ac3ac6fa2686460b8e"></a><!-- doxytag: member="vtkDataObjectSource::SafeDownCast" ref="3b07b4ce0f08b5ac3ac6fa2686460b8e" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00367.html">vtkDataObjectSource</a>* vtkDataObjectSource::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="a01574.html#88f4e1092d2683091041848bc391c5fc">vtkSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="112649593d6f36a0677aca50f3f58e17"></a><!-- doxytag: member="vtkDataObjectSource::PrintSelf" ref="112649593d6f36a0677aca50f3f58e17" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkDataObjectSource::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="a01574.html#11fac66b238c6aac93c9579f3f93eece">vtkSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="1c91a944ec8f7c097274d7b0d42284f7"></a><!-- doxytag: member="vtkDataObjectSource::GetOutput" ref="1c91a944ec8f7c097274d7b0d42284f7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00362.html">vtkDataObject</a>* vtkDataObjectSource::GetOutput </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the output field of this source.
</div>
</div><p>
<a class="anchor" name="87272ee6ae07a3efb5f5803f06116070"></a><!-- doxytag: member="vtkDataObjectSource::GetOutput" ref="87272ee6ae07a3efb5f5803f06116070" args="(int idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00362.html">vtkDataObject</a>* vtkDataObjectSource::GetOutput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the output field of this source.
<p>Reimplemented from <a class="el" href="a01574.html#7893202b9106599623f5683145df895a">vtkSource</a>.</p>
<p>Definition at line <a class="el" href="a04014.html#l00070">70</a> of file <a class="el" href="a04014.html">vtkDataObjectSource.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a08fd9c24708a8aaa3211dad3ecd693"></a><!-- doxytag: member="vtkDataObjectSource::SetOutput" ref="2a08fd9c24708a8aaa3211dad3ecd693" args="(vtkDataObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkDataObjectSource::SetOutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00362.html">vtkDataObject</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1b8d7d930d74b364cfe21571a2d7058d"></a><!-- doxytag: member="vtkDataObjectSource::FillOutputPortInformation" ref="1b8d7d930d74b364cfe21571a2d7058d" args="(int, vtkInformation *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkDataObjectSource::FillOutputPortInformation </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
<p>Reimplemented from <a class="el" href="a01574.html#0224e25a2d3c26670e179f509c5a1a20">vtkSource</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Filtering/<a class="el" href="a04014.html">vtkDataObjectSource.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:59:08 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
370
