<!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: dox/Common/vtkVariantCast.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>dox/Common/vtkVariantCast.h</h1><a href="a02162.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkVariantCast.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"> </span>
<a name="l00006"></a>00006 <span class="comment">-------------------------------------------------------------------------</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright 2008 Sandia Corporation.</span>
<a name="l00008"></a>00008 <span class="comment"> Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,</span>
<a name="l00009"></a>00009 <span class="comment"> the U.S. Government retains certain rights in this software.</span>
<a name="l00010"></a>00010 <span class="comment">-------------------------------------------------------------------------</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00013"></a>00013 <span class="comment"> All rights reserved.</span>
<a name="l00014"></a>00014 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00017"></a>00017 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00018"></a>00018 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">=========================================================================*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __vtkVariantCast_h</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __vtkVariantCast_h</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">// .SECTION Thanks</span>
<a name="l00027"></a>00027 <span class="comment">// Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// Description:</span>
<a name="l00030"></a>00030 <span class="comment">// Converts a vtkVariant to some other type. Wherever possible, implicit conversions are</span>
<a name="l00031"></a>00031 <span class="comment">// performed, so this method can be used to convert from nearly any type to a string, or</span>
<a name="l00032"></a>00032 <span class="comment">// from a string to nearly any type. Note that some conversions may fail at runtime, such</span>
<a name="l00033"></a>00033 <span class="comment">// as a conversion from the string "abc" to a numeric type.</span>
<a name="l00034"></a>00034 <span class="comment">//</span>
<a name="l00035"></a>00035 <span class="comment">// The optional 'valid' flag can be used by callers to verify whether conversion succeeded.</span>
<a name="l00036"></a>00036 <span class="keyword">template</span><<span class="keyword">typename</span> T>
<a name="l00037"></a><a class="code" href="a02162.html#21ffcc4107f44a7ccfb8883d3d9e4d48">00037</a> T <a class="code" href="a02162.html#21ffcc4107f44a7ccfb8883d3d9e4d48">vtkVariantCast</a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>, <span class="keywordtype">bool</span>* valid = 0)
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 vtkGenericWarningMacro(<< <span class="stringliteral">"cannot cast vtkVariant containing "</span> << value.<a class="code" href="a01810.html#141f082d979a67821a72e69d9a37cdd0">GetTypeAsString</a>() << <span class="stringliteral">" to unsupported type."</span>);
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keywordflow">if</span>(valid)
<a name="l00042"></a>00042 *valid = <span class="keyword">false</span>;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">static</span> T dummy;
<a name="l00045"></a>00045 <span class="keywordflow">return</span> dummy;
<a name="l00046"></a>00046 }
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">template</span><>
<a name="l00049"></a>00049 <span class="keyword">inline</span> <span class="keywordtype">char</span> <a class="code" href="a02162.html#06f725f935f355d5ec1876eec819422f">vtkVariantCast<char></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>, <span class="keywordtype">bool</span>* valid)
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keywordflow">return</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>.ToChar(valid);
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keyword">template</span><>
<a name="l00055"></a>00055 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="a02162.html#30bee9c0e4b1d40a8984283baf2b1248">vtkVariantCast<unsigned char></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>, <span class="keywordtype">bool</span>* valid)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <span class="keywordflow">return</span> value.ToUnsignedChar(valid);
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">template</span><>
<a name="l00061"></a>00061 <span class="keyword">inline</span> <span class="keywordtype">short</span> <a class="code" href="a02162.html#e27b68b02e4aaad034b360b3b4c65c60">vtkVariantCast<short></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 <span class="keywordflow">return</span> value.ToShort(valid);
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">template</span><>
<a name="l00067"></a>00067 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="a02162.html#5f0a4af60a1ed248d0a8eb3b5fbb0d57">vtkVariantCast<unsigned short></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keywordflow">return</span> value.ToUnsignedShort(valid);
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">template</span><>
<a name="l00073"></a>00073 <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="a02162.html#74d646a80483aad00b2a0852c3a83493">vtkVariantCast<int></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="keywordflow">return</span> value.ToInt(valid);
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">template</span><>
<a name="l00079"></a>00079 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a02162.html#8fe0a6511b68a6f40a768403df96a187">vtkVariantCast<unsigned int></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <span class="keywordflow">return</span> value.ToUnsignedInt(valid);
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">template</span><>
<a name="l00085"></a>00085 <span class="keyword">inline</span> <span class="keywordtype">long</span> <a class="code" href="a02162.html#255c34bdb9f0641a893c76b026a5bcb9">vtkVariantCast<long></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087 <span class="keywordflow">return</span> value.ToLong(valid);
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keyword">template</span><>
<a name="l00091"></a>00091 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="a02162.html#1d6b5422be8a5be4ed6c315c6aba6da5">vtkVariantCast<unsigned long></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 <span class="keywordflow">return</span> value.ToUnsignedLong(valid);
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="preprocessor">#ifdef VTK_TYPE_USE___INT64</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>
<a name="l00098"></a>00098 <span class="keyword">template</span><>
<a name="l00099"></a>00099 <span class="keyword">inline</span> __int64 vtkVariantCast<__int64>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keywordflow">return</span> value.To__Int64(valid);
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">template</span><>
<a name="l00105"></a>00105 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> __int64 vtkVariantCast<unsigned __int64>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keywordflow">return</span> value.ToUnsigned__Int64(valid);
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#endif</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="preprocessor">#ifdef VTK_TYPE_USE_LONG_LONG</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span>
<a name="l00115"></a>00115 <span class="keyword">template</span><>
<a name="l00116"></a>00116 <span class="keyword">inline</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> vtkVariantCast<long long>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="keywordflow">return</span> value.ToLongLong(valid);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">template</span><>
<a name="l00122"></a>00122 <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> vtkVariantCast<unsigned long long>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 <span class="keywordflow">return</span> value.ToUnsignedLongLong(valid);
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>
<a name="l00129"></a>00129 <span class="keyword">template</span><>
<a name="l00130"></a>00130 <span class="keyword">inline</span> <span class="keywordtype">float</span> <a class="code" href="a02162.html#1d7e29a27ac730571dd430e1b7c75c5a">vtkVariantCast<float></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <span class="keywordflow">return</span> value.ToFloat(valid);
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">template</span><>
<a name="l00136"></a>00136 <span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code" href="a02162.html#b34b05e38b342e3014c98698cf3c7cc6">vtkVariantCast<double></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00137"></a>00137 {
<a name="l00138"></a>00138 <span class="keywordflow">return</span> value.ToDouble(valid);
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">template</span><>
<a name="l00142"></a>00142 <span class="keyword">inline</span> <a class="code" href="a01607.html" title="Wrapper around vtkstd::string to keep symbols short.">vtkStdString</a> <a class="code" href="a02162.html#02d028687cd07e6a11aba9cce4f7ab76">vtkVariantCast<vtkStdString></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00143"></a>00143 {
<a name="l00144"></a>00144 <span class="keywordflow">if</span>(valid)
<a name="l00145"></a>00145 *valid = <span class="keyword">true</span>;
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keywordflow">return</span> value.ToString();
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">template</span><>
<a name="l00151"></a>00151 <span class="keyword">inline</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a> <a class="code" href="a02162.html#69e2c1aa7f5ab70902c9e628a6c2f76f">vtkVariantCast<vtkVariant></a>(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>& value, <span class="keywordtype">bool</span>* valid)
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keywordflow">if</span>(valid)
<a name="l00154"></a>00154 *valid = <span class="keyword">true</span>;
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keywordflow">return</span> value;
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="preprocessor">#endif</span>
<a name="l00160"></a>00160 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:13 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
>
3960
