[bb46557] | 1 | |
---|
| 2 | |
---|
| 3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 4 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 5 | |
---|
[89b7858] | 6 | |
---|
[bb46557] | 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 8 | <head> |
---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 10 | |
---|
[89b7858] | 11 | <title>invariant — invariantview 0.1.0 documentation</title> |
---|
| 12 | |
---|
[bb46557] | 13 | <link rel="stylesheet" href="../_static/default.css" type="text/css" /> |
---|
| 14 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
[89b7858] | 15 | |
---|
[bb46557] | 16 | <script type="text/javascript"> |
---|
| 17 | var DOCUMENTATION_OPTIONS = { |
---|
| 18 | URL_ROOT: '../', |
---|
| 19 | VERSION: '0.1.0', |
---|
| 20 | COLLAPSE_INDEX: false, |
---|
| 21 | FILE_SUFFIX: '.html', |
---|
| 22 | HAS_SOURCE: true |
---|
| 23 | }; |
---|
| 24 | </script> |
---|
| 25 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
| 26 | <script type="text/javascript" src="../_static/underscore.js"></script> |
---|
| 27 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
[89b7858] | 28 | <link rel="top" title="invariantview 0.1.0 documentation" href="../index.html" /> |
---|
[bb46557] | 29 | <link rel="up" title="Reference" href="index.html" /> |
---|
[89b7858] | 30 | <link rel="next" title="invariant_details" href="invariant_details.html" /> |
---|
| 31 | <link rel="prev" title="help_panel" href="help_panel.html" /> |
---|
[bb46557] | 32 | </head> |
---|
| 33 | <body> |
---|
| 34 | <div class="related"> |
---|
| 35 | <h3>Navigation</h3> |
---|
| 36 | <ul> |
---|
| 37 | <li class="right" style="margin-right: 10px"> |
---|
| 38 | <a href="../genindex.html" title="General Index" |
---|
| 39 | accesskey="I">index</a></li> |
---|
| 40 | <li class="right" > |
---|
| 41 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 42 | >modules</a> |</li> |
---|
| 43 | <li class="right" > |
---|
[89b7858] | 44 | <a href="invariant_details.html" title="invariant_details" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="help_panel.html" title="help_panel" |
---|
[bb46557] | 48 | accesskey="P">previous</a> |</li> |
---|
[89b7858] | 49 | <li><a href="../index.html">invariantview 0.1.0 documentation</a> »</li> |
---|
[bb46557] | 50 | <li><a href="index.html" accesskey="U">Reference</a> »</li> |
---|
| 51 | </ul> |
---|
| 52 | </div> |
---|
| 53 | |
---|
| 54 | <div class="document"> |
---|
| 55 | <div class="documentwrapper"> |
---|
| 56 | <div class="bodywrapper"> |
---|
| 57 | <div class="body"> |
---|
| 58 | |
---|
| 59 | <div class="section" id="invariant"> |
---|
| 60 | <h1>invariant<a class="headerlink" href="#invariant" title="Permalink to this headline">¶</a></h1> |
---|
[89b7858] | 61 | <div class="section" id="sans-perspectives-invariant-invariant"> |
---|
| 62 | <h2><a class="reference internal" href="#module-sans.perspectives.invariant.invariant" title="sans.perspectives.invariant.invariant"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.invariant.invariant</span></tt></a><a class="headerlink" href="#sans-perspectives-invariant-invariant" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.perspectives.invariant.invariant"></span><dl class="class"> |
---|
[bb46557] | 64 | <dt id="sans.perspectives.invariant.invariant.Plugin"> |
---|
[89b7858] | 65 | <em class="property">class </em><tt class="descclassname">sans.perspectives.invariant.invariant.</tt><tt class="descname">Plugin</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 66 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.plugin_base.PluginBase</span></tt></p> |
---|
| 67 | <p>This class defines the interface for invariant Plugin class |
---|
| 68 | that can be used by the gui_manager.</p> |
---|
| 69 | <dl class="method"> |
---|
[89b7858] | 70 | <dt id="sans.perspectives.invariant.invariant.Plugin.__init__"> |
---|
| 71 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 72 | <dd></dd></dl> |
---|
| 73 | |
---|
| 74 | <dl class="attribute"> |
---|
| 75 | <dt id="sans.perspectives.invariant.invariant.Plugin.__module__"> |
---|
| 76 | <tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.invariant.invariant'</em><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 77 | <dd></dd></dl> |
---|
| 78 | |
---|
| 79 | <dl class="method"> |
---|
| 80 | <dt id="sans.perspectives.invariant.invariant.Plugin._compute_invariant"> |
---|
| 81 | <tt class="descname">_compute_invariant</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin._compute_invariant" title="Permalink to this definition">¶</a></dt> |
---|
| 82 | <dd><p>Open the invariant panel to invariant computation</p> |
---|
| 83 | </dd></dl> |
---|
| 84 | |
---|
| 85 | <dl class="method"> |
---|
[bb46557] | 86 | <dt id="sans.perspectives.invariant.invariant.Plugin.add_color"> |
---|
[89b7858] | 87 | <tt class="descname">add_color</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.add_color" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 88 | <dd><p>Adds color to a plugin</p> |
---|
| 89 | </dd></dl> |
---|
| 90 | |
---|
| 91 | <dl class="method"> |
---|
| 92 | <dt id="sans.perspectives.invariant.invariant.Plugin.can_load_data"> |
---|
| 93 | <tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.can_load_data" title="Permalink to this definition">¶</a></dt> |
---|
| 94 | <dd><p>if return True, then call handler to laod data</p> |
---|
| 95 | </dd></dl> |
---|
| 96 | |
---|
| 97 | <dl class="method"> |
---|
| 98 | <dt id="sans.perspectives.invariant.invariant.Plugin.clear_panel"> |
---|
| 99 | <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.clear_panel" title="Permalink to this definition">¶</a></dt> |
---|
| 100 | <dd></dd></dl> |
---|
| 101 | |
---|
| 102 | <dl class="method"> |
---|
| 103 | <dt id="sans.perspectives.invariant.invariant.Plugin.compute_helper"> |
---|
[89b7858] | 104 | <tt class="descname">compute_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.compute_helper" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 105 | <dd></dd></dl> |
---|
| 106 | |
---|
| 107 | <dl class="method"> |
---|
| 108 | <dt id="sans.perspectives.invariant.invariant.Plugin.delete_data"> |
---|
[89b7858] | 109 | <tt class="descname">delete_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.delete_data" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 110 | <dd></dd></dl> |
---|
| 111 | |
---|
| 112 | <dl class="method"> |
---|
[89b7858] | 113 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_batch_capable"> |
---|
| 114 | <tt class="descname">get_batch_capable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_batch_capable" title="Permalink to this definition">¶</a></dt> |
---|
| 115 | <dd><p>Check if the plugin has a batch capability</p> |
---|
| 116 | </dd></dl> |
---|
| 117 | |
---|
| 118 | <dl class="method"> |
---|
[bb46557] | 119 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_context_menu"> |
---|
[89b7858] | 120 | <tt class="descname">get_context_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 121 | <dd><p>This method is optional.</p> |
---|
| 122 | <p>When the context menu of a plot is rendered, the |
---|
| 123 | get_context_menu method will be called to give you a |
---|
| 124 | chance to add a menu item to the context menu.</p> |
---|
| 125 | <p>A ref to a Graph object is passed so that you can |
---|
| 126 | investigate the plot content and decide whether you |
---|
| 127 | need to add items to the context menu.</p> |
---|
| 128 | <p>This method returns a list of menu items. |
---|
| 129 | Each item is itself a list defining the text to |
---|
| 130 | appear in the menu, a tool-tip help text, and a |
---|
| 131 | call-back method.</p> |
---|
| 132 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 133 | <col class="field-name" /> |
---|
| 134 | <col class="field-body" /> |
---|
| 135 | <tbody valign="top"> |
---|
[89b7858] | 136 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> – the Graph object to which we attach the context menu</td> |
---|
[bb46557] | 137 | </tr> |
---|
[89b7858] | 138 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td> |
---|
[bb46557] | 139 | </tr> |
---|
| 140 | </tbody> |
---|
| 141 | </table> |
---|
| 142 | </dd></dl> |
---|
| 143 | |
---|
| 144 | <dl class="method"> |
---|
| 145 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_data"> |
---|
| 146 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_data" title="Permalink to this definition">¶</a></dt> |
---|
| 147 | <dd></dd></dl> |
---|
| 148 | |
---|
| 149 | <dl class="method"> |
---|
| 150 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_extensions"> |
---|
| 151 | <tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_extensions" title="Permalink to this definition">¶</a></dt> |
---|
| 152 | <dd><p>return state reader and its extensions</p> |
---|
| 153 | </dd></dl> |
---|
| 154 | |
---|
| 155 | <dl class="method"> |
---|
| 156 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_panels"> |
---|
[89b7858] | 157 | <tt class="descname">get_panels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_panels" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 158 | <dd><p>Create and return the list of wx.Panels for your plug-in. |
---|
| 159 | Define the plug-in perspective.</p> |
---|
| 160 | <p>Panels should inherit from DefaultPanel defined below, |
---|
| 161 | or should present the same interface. They must define |
---|
| 162 | “window_caption” and “window_name”.</p> |
---|
| 163 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 164 | <col class="field-name" /> |
---|
| 165 | <col class="field-body" /> |
---|
| 166 | <tbody valign="top"> |
---|
[89b7858] | 167 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – parent window</td> |
---|
[bb46557] | 168 | </tr> |
---|
[89b7858] | 169 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of panels</td> |
---|
[bb46557] | 170 | </tr> |
---|
| 171 | </tbody> |
---|
| 172 | </table> |
---|
| 173 | </dd></dl> |
---|
| 174 | |
---|
| 175 | <dl class="method"> |
---|
| 176 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_perspective"> |
---|
| 177 | <tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 178 | <dd><p>Get the list of panel names for this perspective</p> |
---|
| 179 | </dd></dl> |
---|
| 180 | |
---|
| 181 | <dl class="method"> |
---|
| 182 | <dt id="sans.perspectives.invariant.invariant.Plugin.get_tools"> |
---|
| 183 | <tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.get_tools" title="Permalink to this definition">¶</a></dt> |
---|
| 184 | <dd><p>Returns a set of menu entries for tools</p> |
---|
| 185 | </dd></dl> |
---|
| 186 | |
---|
| 187 | <dl class="method"> |
---|
| 188 | <dt id="sans.perspectives.invariant.invariant.Plugin.help"> |
---|
[89b7858] | 189 | <tt class="descname">help</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.help" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 190 | <dd><p>Show a general help dialog.</p> |
---|
| 191 | </dd></dl> |
---|
| 192 | |
---|
| 193 | <dl class="method"> |
---|
| 194 | <dt id="sans.perspectives.invariant.invariant.Plugin.is_always_active"> |
---|
| 195 | <tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.is_always_active" title="Permalink to this definition">¶</a></dt> |
---|
| 196 | <dd><p>return True is this plugin is always active and it is local to guiframe |
---|
| 197 | even if the user is switching between perspectives</p> |
---|
| 198 | </dd></dl> |
---|
| 199 | |
---|
| 200 | <dl class="method"> |
---|
| 201 | <dt id="sans.perspectives.invariant.invariant.Plugin.is_in_use"> |
---|
[89b7858] | 202 | <tt class="descname">is_in_use</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.is_in_use" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 203 | <dd><dl class="docutils"> |
---|
| 204 | <dt>get a data id a list of data name if data data is</dt> |
---|
| 205 | <dd>currently used by the plugin and the name of the plugin</dd> |
---|
| 206 | </dl> |
---|
| 207 | <p>data_name = ‘None’ |
---|
| 208 | in_use = False |
---|
| 209 | example [(data_name, self.sub_menu)]</p> |
---|
| 210 | </dd></dl> |
---|
| 211 | |
---|
| 212 | <dl class="method"> |
---|
| 213 | <dt id="sans.perspectives.invariant.invariant.Plugin.load_data"> |
---|
[89b7858] | 214 | <tt class="descname">load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.load_data" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 215 | <dd><p>Load data</p> |
---|
| 216 | </dd></dl> |
---|
| 217 | |
---|
| 218 | <dl class="method"> |
---|
| 219 | <dt id="sans.perspectives.invariant.invariant.Plugin.load_folder"> |
---|
[89b7858] | 220 | <tt class="descname">load_folder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.load_folder" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 221 | <dd><p>Load entire folder</p> |
---|
| 222 | </dd></dl> |
---|
| 223 | |
---|
| 224 | <dl class="method"> |
---|
| 225 | <dt id="sans.perspectives.invariant.invariant.Plugin.on_batch_selection"> |
---|
[89b7858] | 226 | <tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.on_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 227 | <dd><p>need to be overwritten by the derivated class</p> |
---|
| 228 | </dd></dl> |
---|
| 229 | |
---|
| 230 | <dl class="method"> |
---|
| 231 | <dt id="sans.perspectives.invariant.invariant.Plugin.on_perspective"> |
---|
[89b7858] | 232 | <tt class="descname">on_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 233 | <dd><p>Call back function for the perspective menu item. |
---|
| 234 | We notify the parent window that the perspective |
---|
| 235 | has changed.</p> |
---|
| 236 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 237 | <col class="field-name" /> |
---|
| 238 | <col class="field-body" /> |
---|
| 239 | <tbody valign="top"> |
---|
[89b7858] | 240 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> |
---|
[bb46557] | 241 | </tr> |
---|
| 242 | </tbody> |
---|
| 243 | </table> |
---|
| 244 | </dd></dl> |
---|
| 245 | |
---|
| 246 | <dl class="method"> |
---|
| 247 | <dt id="sans.perspectives.invariant.invariant.Plugin.on_set_state_helper"> |
---|
[89b7858] | 248 | <tt class="descname">on_set_state_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.on_set_state_helper" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 249 | <dd><p>Set the state when called by EVT_STATE_UPDATE event from guiframe |
---|
| 250 | after a .inv/.svs file is loaded</p> |
---|
| 251 | </dd></dl> |
---|
| 252 | |
---|
| 253 | <dl class="method"> |
---|
| 254 | <dt id="sans.perspectives.invariant.invariant.Plugin.plot_data"> |
---|
[89b7858] | 255 | <tt class="descname">plot_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.plot_data" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 256 | <dd><p>replot the current data if the user enters a new scale or background</p> |
---|
| 257 | </dd></dl> |
---|
| 258 | |
---|
| 259 | <dl class="method"> |
---|
| 260 | <dt id="sans.perspectives.invariant.invariant.Plugin.plot_theory"> |
---|
[89b7858] | 261 | <tt class="descname">plot_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.plot_theory" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 262 | <dd><p>Receive a data set and post a NewPlotEvent to parent.</p> |
---|
| 263 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 264 | <col class="field-name" /> |
---|
| 265 | <col class="field-body" /> |
---|
| 266 | <tbody valign="top"> |
---|
[89b7858] | 267 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[bb46557] | 268 | <li><strong>data</strong> – extrapolated data to be plotted</li> |
---|
| 269 | <li><strong>name</strong> – Data’s name to use for the legend</li> |
---|
| 270 | </ul> |
---|
| 271 | </td> |
---|
| 272 | </tr> |
---|
| 273 | </tbody> |
---|
| 274 | </table> |
---|
| 275 | </dd></dl> |
---|
| 276 | |
---|
| 277 | <dl class="method"> |
---|
| 278 | <dt id="sans.perspectives.invariant.invariant.Plugin.populate_file_menu"> |
---|
| 279 | <tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.populate_file_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 280 | <dd><p>Append menu item under file menu item of the frame</p> |
---|
| 281 | </dd></dl> |
---|
| 282 | |
---|
| 283 | <dl class="method"> |
---|
| 284 | <dt id="sans.perspectives.invariant.invariant.Plugin.populate_menu"> |
---|
[89b7858] | 285 | <tt class="descname">populate_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 286 | <dd><p>Create and return the list of application menu |
---|
| 287 | items for the plug-in.</p> |
---|
| 288 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 289 | <col class="field-name" /> |
---|
| 290 | <col class="field-body" /> |
---|
| 291 | <tbody valign="top"> |
---|
[89b7858] | 292 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – parent window</td> |
---|
[bb46557] | 293 | </tr> |
---|
[89b7858] | 294 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">plug-in menu</td> |
---|
[bb46557] | 295 | </tr> |
---|
| 296 | </tbody> |
---|
| 297 | </table> |
---|
| 298 | </dd></dl> |
---|
| 299 | |
---|
| 300 | <dl class="method"> |
---|
| 301 | <dt id="sans.perspectives.invariant.invariant.Plugin.post_init"> |
---|
| 302 | <tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.post_init" title="Permalink to this definition">¶</a></dt> |
---|
| 303 | <dd><p>Post initialization call back to close the loose ends</p> |
---|
| 304 | </dd></dl> |
---|
| 305 | |
---|
| 306 | <dl class="method"> |
---|
| 307 | <dt id="sans.perspectives.invariant.invariant.Plugin.save_file"> |
---|
[89b7858] | 308 | <tt class="descname">save_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.save_file" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 309 | <dd><p>Save data in provided state object.</p> |
---|
| 310 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 311 | <col class="field-name" /> |
---|
| 312 | <col class="field-body" /> |
---|
| 313 | <tbody valign="top"> |
---|
[89b7858] | 314 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[bb46557] | 315 | <li><strong>filepath</strong> – path of file to write to</li> |
---|
| 316 | <li><strong>state</strong> – invariant state</li> |
---|
| 317 | </ul> |
---|
| 318 | </td> |
---|
| 319 | </tr> |
---|
| 320 | </tbody> |
---|
| 321 | </table> |
---|
| 322 | </dd></dl> |
---|
| 323 | |
---|
| 324 | <dl class="method"> |
---|
| 325 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_batch_selection"> |
---|
[89b7858] | 326 | <tt class="descname">set_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 327 | <dd><p>the plugin to its batch state if flag is True</p> |
---|
| 328 | </dd></dl> |
---|
| 329 | |
---|
| 330 | <dl class="method"> |
---|
| 331 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_data"> |
---|
[89b7858] | 332 | <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_data" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 333 | <dd><p>receive a list of data and compute invariant</p> |
---|
| 334 | </dd></dl> |
---|
| 335 | |
---|
| 336 | <dl class="method"> |
---|
| 337 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_default_perspective"> |
---|
| 338 | <tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_default_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 339 | <dd><p>Call back method that True to notify the parent that the current plug-in |
---|
| 340 | can be set as default perspective. |
---|
| 341 | when returning False, the plug-in is not candidate for an automatic |
---|
| 342 | default perspective setting</p> |
---|
| 343 | </dd></dl> |
---|
| 344 | |
---|
| 345 | <dl class="method"> |
---|
| 346 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_is_active"> |
---|
[89b7858] | 347 | <tt class="descname">set_is_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_is_active" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 348 | <dd></dd></dl> |
---|
| 349 | |
---|
| 350 | <dl class="method"> |
---|
| 351 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_state"> |
---|
[89b7858] | 352 | <tt class="descname">set_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_state" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 353 | <dd><p>Call-back method for the state reader. |
---|
| 354 | This method is called when a .inv/.svs file is loaded.</p> |
---|
| 355 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 356 | <col class="field-name" /> |
---|
| 357 | <col class="field-body" /> |
---|
| 358 | <tbody valign="top"> |
---|
[89b7858] | 359 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> – State object</td> |
---|
[bb46557] | 360 | </tr> |
---|
| 361 | </tbody> |
---|
| 362 | </table> |
---|
| 363 | </dd></dl> |
---|
| 364 | |
---|
| 365 | <dl class="method"> |
---|
| 366 | <dt id="sans.perspectives.invariant.invariant.Plugin.set_theory"> |
---|
[89b7858] | 367 | <tt class="descname">set_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.set_theory" title="Permalink to this definition">¶</a></dt> |
---|
[bb46557] | 368 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 369 | <col class="field-name" /> |
---|
| 370 | <col class="field-body" /> |
---|
| 371 | <tbody valign="top"> |
---|
[89b7858] | 372 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>theory_list</strong> – list of information</td> |
---|
[bb46557] | 373 | </tr> |
---|
| 374 | </tbody> |
---|
| 375 | </table> |
---|
[89b7858] | 376 | <p>related to available theory state</p> |
---|
[bb46557] | 377 | </dd></dl> |
---|
| 378 | |
---|
| 379 | <dl class="method"> |
---|
| 380 | <dt id="sans.perspectives.invariant.invariant.Plugin.use_data"> |
---|
| 381 | <tt class="descname">use_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant.Plugin.use_data" title="Permalink to this definition">¶</a></dt> |
---|
| 382 | <dd><p>return True if these plugin use data</p> |
---|
| 383 | </dd></dl> |
---|
| 384 | |
---|
| 385 | </dd></dl> |
---|
| 386 | |
---|
| 387 | </div> |
---|
| 388 | </div> |
---|
| 389 | |
---|
| 390 | |
---|
| 391 | </div> |
---|
| 392 | </div> |
---|
| 393 | </div> |
---|
| 394 | <div class="sphinxsidebar"> |
---|
| 395 | <div class="sphinxsidebarwrapper"> |
---|
| 396 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 397 | <ul> |
---|
| 398 | <li><a class="reference internal" href="#">invariant</a><ul> |
---|
[89b7858] | 399 | <li><a class="reference internal" href="#sans-perspectives-invariant-invariant"><tt class="docutils literal"><span class="pre">sans.perspectives.invariant.invariant</span></tt></a></li> |
---|
[bb46557] | 400 | </ul> |
---|
| 401 | </li> |
---|
| 402 | </ul> |
---|
| 403 | |
---|
| 404 | <h4>Previous topic</h4> |
---|
[89b7858] | 405 | <p class="topless"><a href="help_panel.html" |
---|
| 406 | title="previous chapter">help_panel</a></p> |
---|
| 407 | <h4>Next topic</h4> |
---|
| 408 | <p class="topless"><a href="invariant_details.html" |
---|
| 409 | title="next chapter">invariant_details</a></p> |
---|
[bb46557] | 410 | <h3>This Page</h3> |
---|
| 411 | <ul class="this-page-menu"> |
---|
| 412 | <li><a href="../_sources/api/invariant.txt" |
---|
| 413 | rel="nofollow">Show Source</a></li> |
---|
| 414 | </ul> |
---|
| 415 | <div id="searchbox" style="display: none"> |
---|
| 416 | <h3>Quick search</h3> |
---|
| 417 | <form class="search" action="../search.html" method="get"> |
---|
[89b7858] | 418 | <input type="text" name="q" /> |
---|
[bb46557] | 419 | <input type="submit" value="Go" /> |
---|
| 420 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 421 | <input type="hidden" name="area" value="default" /> |
---|
| 422 | </form> |
---|
| 423 | <p class="searchtip" style="font-size: 90%"> |
---|
| 424 | Enter search terms or a module, class or function name. |
---|
| 425 | </p> |
---|
| 426 | </div> |
---|
| 427 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 428 | </div> |
---|
| 429 | </div> |
---|
| 430 | <div class="clearer"></div> |
---|
| 431 | </div> |
---|
| 432 | <div class="related"> |
---|
| 433 | <h3>Navigation</h3> |
---|
| 434 | <ul> |
---|
| 435 | <li class="right" style="margin-right: 10px"> |
---|
| 436 | <a href="../genindex.html" title="General Index" |
---|
| 437 | >index</a></li> |
---|
| 438 | <li class="right" > |
---|
| 439 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 440 | >modules</a> |</li> |
---|
| 441 | <li class="right" > |
---|
[89b7858] | 442 | <a href="invariant_details.html" title="invariant_details" |
---|
| 443 | >next</a> |</li> |
---|
| 444 | <li class="right" > |
---|
| 445 | <a href="help_panel.html" title="help_panel" |
---|
[bb46557] | 446 | >previous</a> |</li> |
---|
[89b7858] | 447 | <li><a href="../index.html">invariantview 0.1.0 documentation</a> »</li> |
---|
[bb46557] | 448 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 449 | </ul> |
---|
| 450 | </div> |
---|
| 451 | <div class="footer"> |
---|
| 452 | © Copyright 2010, sans group. |
---|
[89b7858] | 453 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
[bb46557] | 454 | </div> |
---|
| 455 | </body> |
---|
| 456 | </html> |
---|