File: vtkfiltering_vtkgenericattributecollection.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (205 lines) | stat: -rw-r--r-- 11,902 bytes parent folder | download | duplicates (2) 
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
<!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: vtkGenericAttributeCollection</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&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;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('vtkfiltering_vtkgenericattributecollection.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vtkGenericAttributeCollection </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkGenericAttributeCollection is a class that collects attributes (represented by vtkGenericAttribute).</p>
<p>To create an instance of class vtkGenericAttributeCollection, simply invoke its constructor as follows </p>
<pre class="fragment">  obj = vtkGenericAttributeCollection
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkGenericAttributeCollection 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 vtkGenericAttributeCollection class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> - Standard type definition and print methods for a VTK class.  </li>
<li>
<code>int = obj.IsA (string name)</code> - Standard type definition and print methods for a VTK class.  </li>
<li>
<code>vtkGenericAttributeCollection = obj.NewInstance ()</code> - Standard type definition and print methods for a VTK class.  </li>
<li>
<code>vtkGenericAttributeCollection = obj.SafeDownCast (vtkObject o)</code> - Standard type definition and print methods for a VTK class.  </li>
<li>
<code>int = obj.GetNumberOfAttributes ()</code> - Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result&gt;=0  </dd></dl>
</li>
<li>
<code>int = obj.GetNumberOfComponents ()</code> - Return the number of components. This is the sum of all components found in all attributes. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result&gt;=0  </dd></dl>
</li>
<li>
<code>int = obj.GetNumberOfPointCenteredComponents ()</code> - Return the number of components. This is the sum of all components found in all point centered attributes. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result&gt;=0  </dd></dl>
</li>
<li>
<code>int = obj.GetMaxNumberOfComponents ()</code> - Maximum number of components encountered among all attributes. <dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result&gt;=0 </dd>
<dd>
valid_result: result&lt;=GetNumberOfComponents()  </dd></dl>
</li>
<li>
<code>long = obj.GetActualMemorySize ()</code> - Actual size of the data in kilobytes; only valid after the pipeline has updated. It is guaranteed to be greater than or equal to the memory required to represent the data.  </li>
<li>
<code>int = obj.IsEmpty ()</code> - Indicate whether the collection contains any attributes. <dl class="section post"><dt>Postcondition:</dt><dd>definition: result==(GetNumberOfAttributes()==0)  </dd></dl>
</li>
<li>
<code>vtkGenericAttribute = obj.GetAttribute (int i)</code> - Return a pointer to the ith instance of vtkGenericAttribute. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
valid_i: i&gt;=0 &amp;&amp; i&lt;GetNumberOfAttributes() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>result_exists: result!=0  </dd></dl>
</li>
<li>
<code>int = obj.FindAttribute (string name)</code> - Return the index of the attribute named `name'. Return the non-negative index if found. Return -1 otherwise. <dl class="section pre"><dt>Precondition:</dt><dd>name_exists: name!=0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>valid_result: (result==-1) || (result&gt;=0) &amp;&amp; (result&lt;=GetNumberOfAttributes())  </dd></dl>
</li>
<li>
<code>int = obj.GetAttributeIndex (int i)</code> - Return the index of the first component of attribute `i' in an array of format attrib0comp0 attrib0comp1 ... attrib4comp0 ... <dl class="section pre"><dt>Precondition:</dt><dd>valid_i: i&gt;=0 &amp;&amp; i&lt;GetNumberOfAttributes() </dd>
<dd>
is_point_centered: GetAttribute(i)-&gt;GetCentering()==vtkPointCentered  </dd></dl>
</li>
<li>
<code>obj.InsertNextAttribute (vtkGenericAttribute a)</code> - Add the attribute `a' to the end of the collection. <dl class="section pre"><dt>Precondition:</dt><dd>a_exists: a!=0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>more_items: GetNumberOfAttributes()==old GetNumberOfAttributes()+1 </dd>
<dd>
a_is_set: GetAttribute(GetNumberOfAttributes()-1)==a  </dd></dl>
</li>
<li>
<code>obj.InsertAttribute (int i, vtkGenericAttribute a)</code> - Replace the attribute at index `i' by `a'. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
a_exists: a!=0 </dd>
<dd>
valid_i: i&gt;=0 &amp;&amp; i&lt;GetNumberOfAttributes() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>same_size: GetNumberOfAttributes()==old GetNumberOfAttributes() </dd>
<dd>
item_is_set: GetAttribute(i)==a  </dd></dl>
</li>
<li>
<code>obj.RemoveAttribute (int i)</code> - Remove the attribute at `i'. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
valid_i: i&gt;=0 &amp;&amp; i&lt;GetNumberOfAttributes() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>fewer_items: GetNumberOfAttributes()==old GetNumberOfAttributes()-1  </dd></dl>
</li>
<li>
<code>obj.Reset ()</code> - Remove all attributes. <dl class="section post"><dt>Postcondition:</dt><dd>is_empty: GetNumberOfAttributes()==0  </dd></dl>
</li>
<li>
<code>obj.DeepCopy (vtkGenericAttributeCollection other)</code> - Copy, without reference counting, the other attribute array. <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
not_self: other!=this </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>same_size: GetNumberOfAttributes()==other-&gt;GetNumberOfAttributes()  </dd></dl>
</li>
<li>
<code>obj.ShallowCopy (vtkGenericAttributeCollection other)</code> - Copy, via reference counting, the other attribute array. <dl class="section pre"><dt>Precondition:</dt><dd>other_exists: other!=0 </dd>
<dd>
not_self: other!=this </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>same_size: GetNumberOfAttributes()==other-&gt;GetNumberOfAttributes()  </dd></dl>
</li>
<li>
<code>long = obj.GetMTime ()</code> - vtkAttributeCollection is a composite object and needs to check each member of its collection for modified time.  </li>
<li>
<code>int = obj.GetActiveAttribute ()</code> - Index of the attribute to be processed (not necessarily scalar). <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>valid_result: result&gt;=0 &amp;&amp; result&lt;GetNumberOfAttributes()  </dd></dl>
</li>
<li>
<code>int = obj.GetActiveComponent ()</code> - Component of the active attribute to be processed. -1 means module. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: GetNumberOfAttributes()&gt;0 </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>valid_result: result&gt;=-1 &amp;&amp; result&lt;GetAttribute(GetActiveAttribute())-&gt;GetNumberOfComponents()  </dd></dl>
</li>
<li>
<code>obj.SetActiveAttribute (int attribute, int component)</code> - Set the scalar attribute to be processed. -1 means module. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
valid_attribute: attribute&gt;=0 &amp;&amp; attribute&lt;GetNumberOfAttributes() </dd>
<dd>
valid_component: component&gt;=-1 &amp;&amp; component&lt;GetAttribute(attribute)-&gt;GetNumberOfComponents() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: GetActiveAttribute()==attribute &amp;&amp; GetActiveComponent()==component  </dd></dl>
</li>
<li>
<code>int = obj.GetNumberOfAttributesToInterpolate ()</code> - Number of attributes to interpolate. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>positive_result: result&gt;=0  </dd></dl>
</li>
<li>
<code>int = obj.HasAttribute (int size, int attributes, int attribute)</code>  </li>
<li>
<code>obj.SetAttributesToInterpolate (int size, int attributes)</code> - Set the attributes to interpolate. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
positive_size: size&gt;=0 </dd>
<dd>
valid_attributes: size&gt;0 implies attributes!=0 </dd>
<dd>
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute()) </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: (GetNumberOfAttributesToInterpolate()==size)&amp;&amp; (GetAttributesToInterpolate()==attributes)  </dd></dl>
</li>
<li>
<code>obj.SetAttributesToInterpolateToAll ()</code> - Set the attributes to interpolate. <dl class="section pre"><dt>Precondition:</dt><dd>not_empty: !IsEmpty() </dd>
<dd>
positive_size: size&gt;=0 </dd>
<dd>
valid_attributes: size&gt;0 implies attributes!=0 </dd>
<dd>
valid_attributes_contents: attributes!=0 implies !HasAttributes(size,attributes,GetActiveAttribute()) </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>is_set: (GetNumberOfAttributesToInterpolate()==size)&amp;&amp; (GetAttributesToInterpolate()==attributes)  </dd></dl>
</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_vtkfiltering.html">Visualization Toolkit Filtering 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>