<!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: vtkInformationStringKey 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>vtkInformationStringKey Class Reference</h1><!-- doxytag: class="vtkInformationStringKey" --><!-- doxytag: inherits="vtkInformationKey" --><code>#include <<a class="el" href="a03853.html">vtkInformationStringKey.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkInformationStringKey:</div>
<div class="dynsection">
<p><center><img src="a11490.png" border="0" usemap="#a11491" alt="Inheritance graph"></center>
<map name="a11491">
<area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="24,80,155,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="35,6,144,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkInformationStringKey:</div>
<div class="dynsection">
<p><center><img src="a11492.png" border="0" usemap="#a11493" alt="Collaboration graph"></center>
<map name="a11493">
<area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="24,80,155,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="35,6,144,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a11494.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Key for string values in <a class="el" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>.
<p>
<a class="el" href="a00892.html" title="Key for string values in vtkInformation.">vtkInformationStringKey</a> is used to represent keys for string values in <a class="el" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>.
<p>Definition at line <a class="el" href="a03853.html#l00029">29</a> of file <a class="el" href="a03853.html">vtkInformationStringKey.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="a00886.html">vtkInformationKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#6a5b330bc7a588d7954fd50c7a685b41">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="a00892.html#6e01f94722320ba2c571e81c9988173a">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="a00892.html#87faff90f595f7006339ee4fe601536b">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="a00892.html#9b6dfbc0e3f4f532ebfb15f67922019c">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#7755c19cdc27ce109db3fc77203d8e36">vtkInformationStringKey</a> (const char *name, const char *location)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#90465659c91a274a1466eaec3004469a">~vtkInformationStringKey</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#028364357d08dc35b16ee49e1d61b93f">ShallowCopy</a> (<a class="el" href="a00872.html">vtkInformation</a> *from, <a class="el" href="a00872.html">vtkInformation</a> *to)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#54688c94b676c0f528b061d29be40972">Print</a> (ostream &os, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#9473d6940c0aa21d60ab1d05db07f981">Set</a> (<a class="el" href="a00872.html">vtkInformation</a> *info, const char *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#f71885fa713f223a7f8954c8f52de968">Get</a> (<a class="el" href="a00872.html">vtkInformation</a> *info)</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="a00892.html#2b977c3ad283428c22269190edc9d2ec">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00892.html">vtkInformationStringKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00892.html#e06f589449c3cee8306e62a48d4e6d61">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="6a5b330bc7a588d7954fd50c7a685b41"></a><!-- doxytag: member="vtkInformationStringKey::Superclass" ref="6a5b330bc7a588d7954fd50c7a685b41" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00886.html">vtkInformationKey</a> <a class="el" href="a00886.html">vtkInformationStringKey::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00886.html#dbd0da103a7d660b028ecbd01ee7ae7c">vtkInformationKey</a>.</p>
<p>Definition at line <a class="el" href="a03853.html#l00032">32</a> of file <a class="el" href="a03853.html">vtkInformationStringKey.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7755c19cdc27ce109db3fc77203d8e36"></a><!-- doxytag: member="vtkInformationStringKey::vtkInformationStringKey" ref="7755c19cdc27ce109db3fc77203d8e36" args="(const char *name, const char *location)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkInformationStringKey::vtkInformationStringKey </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>location</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="90465659c91a274a1466eaec3004469a"></a><!-- doxytag: member="vtkInformationStringKey::~vtkInformationStringKey" ref="90465659c91a274a1466eaec3004469a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkInformationStringKey::~vtkInformationStringKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6e01f94722320ba2c571e81c9988173a"></a><!-- doxytag: member="vtkInformationStringKey::GetClassName" ref="6e01f94722320ba2c571e81c9988173a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkInformationStringKey::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="a00886.html#34f8b37f8d5a790ecb14aaada0e21de1">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="2b977c3ad283428c22269190edc9d2ec"></a><!-- doxytag: member="vtkInformationStringKey::IsTypeOf" ref="2b977c3ad283428c22269190edc9d2ec" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkInformationStringKey::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="a00886.html#36c3f45a797eabbb5558d243c35a9707">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="87faff90f595f7006339ee4fe601536b"></a><!-- doxytag: member="vtkInformationStringKey::IsA" ref="87faff90f595f7006339ee4fe601536b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkInformationStringKey::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="a00886.html#fbcec9292c0ba6d1be47764d0fb1b1ca">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="e06f589449c3cee8306e62a48d4e6d61"></a><!-- doxytag: member="vtkInformationStringKey::SafeDownCast" ref="e06f589449c3cee8306e62a48d4e6d61" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00892.html">vtkInformationStringKey</a>* vtkInformationStringKey::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="a00886.html#84de489d7b115fb24fef9010285a1940">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b6dfbc0e3f4f532ebfb15f67922019c"></a><!-- doxytag: member="vtkInformationStringKey::PrintSelf" ref="9b6dfbc0e3f4f532ebfb15f67922019c" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkInformationStringKey::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="a00892.html#54688c94b676c0f528b061d29be40972">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
<p>Reimplemented from <a class="el" href="a00886.html#65055df76afda6ed7f641cfc057ffe92">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="9473d6940c0aa21d60ab1d05db07f981"></a><!-- doxytag: member="vtkInformationStringKey::Set" ref="9473d6940c0aa21d60ab1d05db07f981" args="(vtkInformation *info, const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkInformationStringKey::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname"> <em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get/Set the value associated with this key in the given information object.
</div>
</div><p>
<a class="anchor" name="f71885fa713f223a7f8954c8f52de968"></a><!-- doxytag: member="vtkInformationStringKey::Get" ref="f71885fa713f223a7f8954c8f52de968" args="(vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* vtkInformationStringKey::Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname"> <em>info</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get/Set the value associated with this key in the given information object.
</div>
</div><p>
<a class="anchor" name="028364357d08dc35b16ee49e1d61b93f"></a><!-- doxytag: member="vtkInformationStringKey::ShallowCopy" ref="028364357d08dc35b16ee49e1d61b93f" args="(vtkInformation *from, vtkInformation *to)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkInformationStringKey::ShallowCopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td>
<td class="paramname"> <em>from</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>to</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>
Copy the entry associated with this key from one information object to another. If there is no entry in the first information object for this key, the value is removed from the second.
<p>Implements <a class="el" href="a00886.html#f3d7e1aa92236fdbff7dd8b606b1b971">vtkInformationKey</a>.</p>
</div>
</div><p>
<a class="anchor" name="54688c94b676c0f528b061d29be40972"></a><!-- doxytag: member="vtkInformationStringKey::Print" ref="54688c94b676c0f528b061d29be40972" args="(ostream &os, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkInformationStringKey::Print </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="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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Print the key's value in an information object to a stream.
<p>Reimplemented from <a class="el" href="a00886.html#f7087c48ca7d91b692f01a8e2e8108fb">vtkInformationKey</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03853.html">vtkInformationStringKey.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:12:44 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
>
895
