1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkTableExtentTranslator</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkcommon_vtktableextenttranslator.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkTableExtentTranslator </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkcommon.html">Visualization Toolkit Common Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkTableExtentTranslator provides a vtkExtentTranslator that is programmed with a specific extent corresponding to each piece number. Readers can provide this to an application to allow the pipeline to execute using the same piece breakdown that is provided in the input file.</p>
<p>To create an instance of class vtkTableExtentTranslator, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkTableExtentTranslator
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkTableExtentTranslator has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkTableExtentTranslator class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkTableExtentTranslator = obj.NewInstance ()</code> </li>
<li>
<code>vtkTableExtentTranslator = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetNumberOfPieces (int pieces)</code> </li>
<li>
<code>obj.SetNumberOfPiecesInTable (int pieces)</code> - Set the real number of pieces in the extent table. </li>
<li>
<code>int = obj.GetNumberOfPiecesInTable ()</code> - Set the real number of pieces in the extent table. </li>
<li>
<code>int = obj.PieceToExtent ()</code> - Called to translate the current piece into an extent. This is not thread safe. </li>
<li>
<code>int = obj.PieceToExtentByPoints ()</code> - Not supported by this subclass of vtkExtentTranslator. </li>
<li>
<code>int = obj.PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int wholeExtent, int resultExtent, int splitMode, int byPoints)</code> - Not supported by this subclass of vtkExtentTranslator. </li>
<li>
<code>obj.SetExtentForPiece (int piece, int extent)</code> - Set the extent to be used for a piece. This sets the extent table entry for the piece. </li>
<li>
<code>obj.GetExtentForPiece (int piece, int extent)</code> - Get the extent table entry for the given piece. This is only for code that is setting up the table. Extent translation should always be done through the PieceToExtent method. </li>
<li>
<code>obj.SetMaximumGhostLevel (int )</code> - Set the maximum ghost level that can be requested. This can be used by a reader to make sure an extent request does not go outside the boundaries of the piece's file. </li>
<li>
<code>int = obj.GetMaximumGhostLevel ()</code> - Set the maximum ghost level that can be requested. This can be used by a reader to make sure an extent request does not go outside the boundaries of the piece's file. </li>
<li>
<code>obj.SetPieceAvailable (int piece, int available)</code> - Get/Set whether the given piece is available. Requesting a piece that is not available will produce errors in the pipeline. </li>
<li>
<code>int = obj.GetPieceAvailable (int piece)</code> - Get/Set whether the given piece is available. Requesting a piece that is not available will produce errors in the pipeline. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkcommon.html">Visualization Toolkit Common Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:30 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
