Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Initial commit...

  • Loading branch information...
commit 847a6fd9aada4e5ece59515bd7bb2cc1d8276a9f 0 parents
Mannie Tags authored
Showing with 5,962 additions and 0 deletions.
  1. +165 −0 LICENCE
  2. +80 −0 README
  3. +301 −0 doc/LICENCE.html
  4. +251 −0 doc/README.html
  5. +184 −0 doc/T2Flow.html
  6. +203 −0 doc/T2Flow/Coordination.html
  7. +382 −0 doc/T2Flow/Dataflow.html
  8. +241 −0 doc/T2Flow/DataflowAnnotation.html
  9. +203 −0 doc/T2Flow/Datalink.html
  10. +334 −0 doc/T2Flow/Dot.html
  11. +654 −0 doc/T2Flow/Model.html
  12. +219 −0 doc/T2Flow/Parser.html
  13. +301 −0 doc/T2Flow/Processor.html
  14. +184 −0 doc/T2Flow/Sink.html
  15. +185 −0 doc/T2Flow/Source.html
  16. +1 −0  doc/created.rid
  17. BIN  doc/images/brick.png
  18. BIN  doc/images/brick_link.png
  19. BIN  doc/images/bug.png
  20. BIN  doc/images/bullet_black.png
  21. BIN  doc/images/bullet_toggle_minus.png
  22. BIN  doc/images/bullet_toggle_plus.png
  23. BIN  doc/images/date.png
  24. BIN  doc/images/find.png
  25. BIN  doc/images/loadingAnimation.gif
  26. BIN  doc/images/macFFBgHack.png
  27. BIN  doc/images/package.png
  28. BIN  doc/images/page_green.png
  29. BIN  doc/images/page_white_text.png
  30. BIN  doc/images/page_white_width.png
  31. BIN  doc/images/plugin.png
  32. BIN  doc/images/ruby.png
  33. BIN  doc/images/tag_green.png
  34. BIN  doc/images/wrench.png
  35. BIN  doc/images/wrench_orange.png
  36. BIN  doc/images/zoom.png
  37. +269 −0 doc/index.html
  38. +116 −0 doc/js/darkfish.js
  39. +32 −0 doc/js/jquery.js
  40. +114 −0 doc/js/quicksearch.js
  41. +10 −0 doc/js/thickbox-compressed.js
  42. +52 −0 doc/lib/t2flow/dot_rb.html
  43. +56 −0 doc/lib/t2flow/model_rb.html
  44. +54 −0 doc/lib/t2flow/parser_rb.html
  45. +696 −0 doc/rdoc.css
  46. +250 −0 lib/t2flow/dot.rb
  47. +200 −0 lib/t2flow/model.rb
  48. +192 −0 lib/t2flow/parser.rb
  49. +33 −0 t2flow.gemspec
165 LICENCE
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
80 README
@@ -0,0 +1,80 @@
+= Taverna[http://taverna.sourceforge.net] 2 Interaction Gem
+
+Author:: Emmanuel Tagarira
+Version:: 0.0.0
+Contact:: mailto:emmanuel.tagarira@student.manchester.ac.uk
+URL:: http://taverna.sourceforge.net/
+Licence:: LGPL 3 (See LICENCE or http://www.gnu.org/licenses/lgpl.html)
+Copyright:: (c) 2008-2009 University of Manchester, UK
+
+
+
+== Synopsis
+
+This is a Ruby library to support the interaction with Taverna[http://taverna.sourceforge.net] version 2 workflows (T2Flows). This relies on the functionality provided by the libxml library. To be able to utilise this gem to its full potential, you will need to have the following installed on your system.
+- GraphViz[http://www.graphviz.org/Download.php] (a graph visualization package)
+- Rdoc gem
+- Darkfish-Rdoc gem
+
+
+
+== The T2Flow Model Implementation
+
+Much like the Taverna[http://taverna.sourceforge.net] 1 Scufl model, T2Flows contain Processors, Sinks, and Sources. T2Flows however, encapsulate these elements within Dataflow objects. A Dataflow objects is the container for all the different elements present within the Taverna[http://taverna.sourceforge.net] 2 workflows, hence a single T2Flow may have one or more dataflows. WorkflowDescriptions and Links, from the original Taverna[http://taverna.sourceforge.net] 1 workflows (Scufl), have been renamed in T2Flows to DataflowAnnotations and Datalinks respectively. DataflowAnnotations, however, allow for multiple titles, authors, and descriptions, as opposed to the single value attributes held for Scufls.
+
+
+
+== Installation
+To install the gems required by the Taverna 2 gem library, type into your command prompt:
+ [sudo] gem install libxml-ruby
+ [sudo] gem install rdoc
+ [sudo] gem install darkfish-rdoc
+
+When you have the required gems on your system, you may install this gem using the following commands:
+ gem sources -a http://gems.github.com
+ [sudo] gem install mannie-taverna-t2flow
+
+
+
+== Usage
+
+To be able to generate at least a T2Flow model using the gem, you need to include in your ruby code the following lines:
+ require "t2flow/model.rb"
+ require "t2flow/parser.rb"
+
+To generate the model you can then use the gem as follows:
+ foo = File.new("path/to/workflow/file", "r")
+ bar = T2Flow::Parser.new.parse(foo)
+
+Alternatively:
+ foo = File.new("path/to/workflow/file", "r").read
+ bar = T2Flow::Parser.new.parse(foo)
+
+You will then be able to use your T2Flow model to retrieve information about the workflow by invoking the different methods and attributes.
+ bar.INVOKED
+... where INVOKED is the method or attribute required.
+
+You can also interact with remote workflows.
+ require "open-uri"
+
+ foo = Uri.parse("xxxx://uri_to_workflow").read
+ bar = T2Flow::Parser.new.parse(foo)
+
+To be enable you to draw images of the T2Flow, you need to include:
+ require "t2flow/dot.rb"
+
+To be able to use any functionality included in "t2flow/dot.rb", you need to have GraphViz[http://www.graphviz.org/Download.php] installed on your system. Once this package has been installed, you may use the gem to draw an image showing the structure of the T2Flow as follows.
+ out_file = File.new("path/to/file/you/want/the/dot/script/to/be/written", "w+")
+ T2Flow::Dot.new.write_dot(out_file, bar)
+ `dot -Tpng -o"path/to/the/output/image" #{out_file.path}`
+The last line draws a PNG image using +out_file+. To learn more about dot, try typing into your command prompt:
+ % man dot
+or
+ % dot -h
+
+
+
+== References
+
+[1] http://taverna.sourceforge.net
+[2] http://www.graphviz.org
301 doc/LICENCE.html
@@ -0,0 +1,301 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>File: LICENCE [Taverna T2Flow]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <script src="./js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+</head>
+
+<body class="file">
+ <div id="metadata">
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="./LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="./README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="./images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="./T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="./T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="./T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="./T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="./T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="./T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="./T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="./T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="./T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="./T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <pre>
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. &lt;http://fsf.org/&gt;
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ This version of the GNU Lesser General Public License incorporates
+</pre>
+<p>
+the terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+</p>
+<pre>
+ 0. Additional Definitions.
+
+ As used herein, &quot;this License&quot; refers to version 3 of the GNU Lesser
+</pre>
+<p>
+General Public License, and the &#8220;GNU GPL&#8221; refers to version 3
+of the GNU General Public License.
+</p>
+<pre>
+ &quot;The Library&quot; refers to a covered work governed by this License,
+</pre>
+<p>
+other than an Application or a Combined Work as defined below.
+</p>
+<pre>
+ An &quot;Application&quot; is any work that makes use of an interface provided
+</pre>
+<p>
+by the Library, but which is not otherwise based on the Library. Defining a
+subclass of a class defined by the Library is deemed a mode of using an
+interface provided by the Library.
+</p>
+<pre>
+ A &quot;Combined Work&quot; is a work produced by combining or linking an
+</pre>
+<p>
+Application with the Library. The particular version of the Library with
+which the Combined Work was made is also called the &#8220;Linked
+Version&#8221;.
+</p>
+<pre>
+ The &quot;Minimal Corresponding Source&quot; for a Combined Work means the
+</pre>
+<p>
+Corresponding Source for the Combined Work, excluding any source code for
+portions of the Combined Work that, considered in isolation, are based on
+the Application, and not on the Linked Version.
+</p>
+<pre>
+ The &quot;Corresponding Application Code&quot; for a Combined Work means the
+</pre>
+<p>
+object code and/or source code for the Application, including any data and
+utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+</p>
+<pre>
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+</pre>
+<p>
+without being bound by section 3 of the GNU GPL.
+</p>
+<pre>
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+</pre>
+<p>
+facility refers to a function or data to be supplied by an Application that
+uses the facility (other than as an argument passed when the facility is
+invoked), then you may convey a copy of the modified version:
+</p>
+<pre>
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+</pre>
+<p>
+a header file that is part of the Library. You may convey such object code
+under terms of your choice, provided that, if the incorporated material is
+not limited to numerical parameters, data structure layouts and accessors,
+or small macros, inline functions and templates (ten or fewer lines in
+length), you do both of the following:
+</p>
+<pre>
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+</pre>
+<p>
+taken together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+</p>
+<pre>
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+</pre>
+<p>
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this License,
+and convey such a combined library under terms of your choice, if you do
+both of the following:
+</p>
+<pre>
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+</pre>
+<p>
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may differ
+in detail to address new problems or concerns.
+</p>
+<pre>
+ Each version is given a distinguishing version number. If the
+</pre>
+<p>
+Library as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License &#8220;or any later version&#8221;
+applies to it, you have the option of following the terms and conditions
+either of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you may
+choose any version of the GNU Lesser General Public License ever published
+by the Free Software Foundation.
+</p>
+<pre>
+ If the Library as you received it specifies that a proxy can decide
+</pre>
+<p>
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy&#8217;s public statement of acceptance of any version is
+permanent authorization for you to choose that version for the Library.
+</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+</body>
+</html>
+
251 doc/README.html
@@ -0,0 +1,251 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>File: README [Taverna T2Flow]</title>
+
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+
+ <script src="./js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+</head>
+
+<body class="file">
+ <div id="metadata">
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="./LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="./README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="./images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="./T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="./T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="./T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="./T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="./T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="./T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="./T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="./T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="./T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="./T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1><a href="http://taverna.sourceforge.net">Taverna</a> 2 Interaction Gem</h1>
+<table>
+<tr><td valign="top">Author:</td><td>Emmanuel Tagarira
+
+</td></tr>
+<tr><td valign="top">Version:</td><td>0.0.0
+
+</td></tr>
+<tr><td valign="top">Contact:</td><td><a
+href="mailto:emmanuel.tagarira@student.manchester.ac.uk">emmanuel.tagarira@student.manchester.ac.uk</a>
+
+</td></tr>
+<tr><td valign="top">URL:</td><td><a href="http://taverna.sourceforge.net/">taverna.sourceforge.net/</a>
+
+</td></tr>
+<tr><td valign="top">Licence:</td><td>LGPL 3 (See <a href="LICENCE.html">LICENCE</a> or <a
+href="http://www.gnu.org/licenses/lgpl.html">www.gnu.org/licenses/lgpl.html</a>)
+
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>&#169; 2008-2009 University of Manchester, UK
+
+</td></tr>
+</table>
+<h2>Synopsis</h2>
+<p>
+This is a Ruby library to support the interaction with <a
+href="http://taverna.sourceforge.net">Taverna</a> version 2 workflows
+(T2Flows). This relies on the functionality provided by the libxml library.
+To be able to utilise this gem to its full potential, you will need to have
+the following installed on your system.
+</p>
+<ul>
+<li><a href="http://www.graphviz.org/Download.php">GraphViz</a> (a graph
+visualization package)
+
+</li>
+<li>Rdoc gem
+
+</li>
+<li>Darkfish-Rdoc gem
+
+</li>
+</ul>
+<h2>The T2Flow Model Implementation</h2>
+<p>
+Much like the <a href="http://taverna.sourceforge.net">Taverna</a> 1 Scufl
+model, T2Flows contain Processors, Sinks, and Sources. T2Flows however,
+encapsulate these elements within Dataflow objects. A Dataflow objects is
+the container for all the different elements present within the <a
+href="http://taverna.sourceforge.net">Taverna</a> 2 workflows, hence a
+single T2Flow may have one or more dataflows. WorkflowDescriptions and
+Links, from the original <a
+href="http://taverna.sourceforge.net">Taverna</a> 1 workflows (Scufl), have
+been renamed in T2Flows to DataflowAnnotations and Datalinks respectively.
+DataflowAnnotations, however, allow for multiple titles, authors, and
+descriptions, as opposed to the single value attributes held for Scufls.
+</p>
+<h2>Installation</h2>
+<p>
+To install the gems required by the Taverna 2 gem library, type into your
+command prompt:
+</p>
+<pre>
+ [sudo] gem install libxml-ruby
+ [sudo] gem install rdoc
+ [sudo] gem install darkfish-rdoc
+</pre>
+<p>
+When you have the required gems on your system, you may install this gem
+using the following commands:
+</p>
+<pre>
+ gem sources -a http://gems.github.com
+ [sudo] gem install myGrid-taverna-t2flow
+</pre>
+<h2>Usage</h2>
+<p>
+To be able to generate at least a T2Flow model using the gem, you need to
+include in your ruby code the following lines:
+</p>
+<pre>
+ require &quot;t2flow/model.rb&quot;
+ require &quot;t2flow/parser.rb&quot;
+</pre>
+<p>
+To generate the model you can then use the gem as follows:
+</p>
+<pre>
+ foo = File.new(&quot;path/to/workflow/file&quot;, &quot;r&quot;)
+ bar = T2Flow::Parser.new.parse(foo)
+</pre>
+<p>
+Alternatively:
+</p>
+<pre>
+ foo = File.new(&quot;path/to/workflow/file&quot;, &quot;r&quot;).read
+ bar = T2Flow::Parser.new.parse(foo)
+</pre>
+<p>
+You will then be able to use your T2Flow model to retrieve information
+about the workflow by invoking the different methods and attributes.
+</p>
+<pre>
+ bar.INVOKED
+</pre>
+<p>
+&#8230; where INVOKED is the method or attribute required.
+</p>
+<p>
+You can also interact with remote workflows.
+</p>
+<pre>
+ require &quot;open-uri&quot;
+
+ foo = Uri.parse(&quot;xxxx://uri_to_workflow&quot;).read
+ bar = T2Flow::Parser.new.parse(foo)
+</pre>
+<p>
+To be enable you to draw images of the T2Flow, you need to include:
+</p>
+<pre>
+ require &quot;t2flow/dot.rb&quot;
+</pre>
+<p>
+To be able to use any functionality included in
+&#8220;t2flow/dot.rb&#8220;, you need to have <a
+href="http://www.graphviz.org/Download.php">GraphViz</a> installed on your
+system. Once this package has been installed, you may use the gem to draw
+an image showing the structure of the T2Flow as follows.
+</p>
+<pre>
+ out_file = File.new(&quot;path/to/file/you/want/the/dot/script/to/be/written&quot;, &quot;w+&quot;)
+ T2Flow::Dot.new.write_dot(out_file, bar)
+ `dot -Tpng -o&quot;path/to/the/output/image&quot; #{out_file.path}`
+</pre>
+<p>
+The last line draws a PNG image using <tt>out_file</tt>. To learn more
+about dot, try typing into your command prompt:
+</p>
+<pre>
+ % man dot
+</pre>
+<p>
+or
+</p>
+<pre>
+ % dot -h
+</pre>
+<h2>References</h2>
+<dl>
+<dt>1</dt><dd><a href="http://taverna.sourceforge.net">taverna.sourceforge.net</a>
+
+</dd>
+<dt>2</dt><dd><a href="http://www.graphviz.org">www.graphviz.org</a>
+
+</dd>
+</dl>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+</body>
+</html>
+
184 doc/T2Flow.html
@@ -0,0 +1,184 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Module: T2Flow</title>
+
+ <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+ <script src="./js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="./js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="module">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="./lib/t2flow/dot_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/dot.rb">lib/t2flow/dot.rb</a></li>
+
+ <li><a href="./lib/t2flow/model_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/model.rb">lib/t2flow/model.rb</a></li>
+
+ <li><a href="./lib/t2flow/parser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/parser.rb">lib/t2flow/parser.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+ <div id="namespace-list-section" class="section">
+ <h3 class="section-header">Namespace</h3>
+ <ul class="link-list">
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><span class="type">CLASS</span> <a href="T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="./LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="./README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="./images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="./T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="./T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="./T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="./T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="./T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="./T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="./T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="./T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="./T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="./T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="module">T2Flow</h1>
+
+ <div id="description">
+ <p>
+This is the module containing the T2Flow model implementation i.e. the
+model structure/definition and all its internals.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+
+ </div>
+
+
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
203 doc/T2Flow/Coordination.html
@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: T2Flow::Coordination</title>
+
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/t2flow/model_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/model.rb">lib/t2flow/model.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="../T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="../T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="../T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="../T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="../T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="../T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="../T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="../T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="../T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">T2Flow::Coordination</h1>
+
+ <div id="description">
+ <p>
+This is a representation of the &#8216;Run after...&#8217; function in
+Taverna where the selected processor or workflow is set to run after
+another.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="control-attribute-method" class="method-detail">
+ <a name="control"></a>
+
+ <a name="control="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">control</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The name of the processor/workflow which is to run first.
+</p>
+
+ </div>
+ </div>
+
+ <div id="target-attribute-method" class="method-detail">
+ <a name="target"></a>
+
+ <a name="target="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">target</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The name of the processor/workflow which is to run after the control.
+</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+
+ </div>
+
+
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
382 doc/T2Flow/Dataflow.html
@@ -0,0 +1,382 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: T2Flow::Dataflow</title>
+
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/t2flow/model_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/model.rb">lib/t2flow/model.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000014">::new</a></li>
+
+ <li><a href="#M000015">#beanshells</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="../T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="../T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="../T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="../T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="../T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="../T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="../T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="../T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="../T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">T2Flow::Dataflow</h1>
+
+ <div id="description">
+ <p>
+The entities within the Taverna 2 mdoel which contains the different
+elements of the workflows; processors, sinks, sources, etc...
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="annotations-attribute-method" class="method-detail">
+ <a name="annotations"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">annotations</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+This returns a <a href="DataflowAnnotation.html">DataflowAnnotation</a>
+object.
+</p>
+
+ </div>
+ </div>
+
+ <div id="processors-attribute-method" class="method-detail">
+ <a name="processors"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">processors</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the list of processors specific to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="datalinks-attribute-method" class="method-detail">
+ <a name="datalinks"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">datalinks</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the list of datalinks specific to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="sources-attribute-method" class="method-detail">
+ <a name="sources"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">sources</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the list of sources specific to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="sinks-attribute-method" class="method-detail">
+ <a name="sinks"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">sinks</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the list of sinks specific to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="coordinations-attribute-method" class="method-detail">
+ <a name="coordinations"></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">coordinations</span><span
+ class="attribute-access-type">[R]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve the list of coordinations specific to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="dataflow-id-attribute-method" class="method-detail">
+ <a name="dataflow_id"></a>
+
+ <a name="dataflow_id="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">dataflow_id</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The unique identifier of the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000014"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a new <a href="Dataflow.html">Dataflow</a> object.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="new-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/t2flow/model.rb, line 135</span>
+135: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+136: <span class="ruby-ivar">@annotations</span> = <span class="ruby-constant">DataflowAnnotation</span>.<span class="ruby-identifier">new</span>
+137: <span class="ruby-ivar">@processors</span> = []
+138: <span class="ruby-ivar">@datalinks</span> = []
+139: <span class="ruby-ivar">@sources</span> = []
+140: <span class="ruby-ivar">@sinks</span> = []
+141: <span class="ruby-ivar">@coordinations</span> = []
+142: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>
+
+
+ <div id="beanshells-method" class="method-detail ">
+ <a name="M000015"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">beanshells</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Retrieve beanshell processors specific to this dataflow.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="beanshells-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/t2flow/model.rb, line 145</span>
+145: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">beanshells</span>
+146: <span class="ruby-ivar">@processors</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;beanshell&quot;</span> }
+147: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
241 doc/T2Flow/DataflowAnnotation.html
@@ -0,0 +1,241 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: T2Flow::DataflowAnnotation</title>
+
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/t2flow/model_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/model.rb">lib/t2flow/model.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="../T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="../T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="../T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="../T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="../T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="../T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="../T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="../T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="../T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">T2Flow::DataflowAnnotation</h1>
+
+ <div id="description">
+ <p>
+This is the annotation object specific to the dataflow it belongs to. A <a
+href="DataflowAnnotation.html">DataflowAnnotation</a> contains metadata
+about a given dataflow element.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="name-attribute-method" class="method-detail">
+ <a name="name"></a>
+
+ <a name="name="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">name</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The name used of the dataflow
+</p>
+
+ </div>
+ </div>
+
+ <div id="titles-attribute-method" class="method-detail">
+ <a name="titles"></a>
+
+ <a name="titles="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">titles</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+A list of titles that have been assigned to the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="descriptions-attribute-method" class="method-detail">
+ <a name="descriptions"></a>
+
+ <a name="descriptions="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">descriptions</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+A list ot descriptive strings about the dataflow.
+</p>
+
+ </div>
+ </div>
+
+ <div id="authors-attribute-method" class="method-detail">
+ <a name="authors"></a>
+
+ <a name="authors="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">authors</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+A list of authors of the dataflow
+</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+
+ </div>
+
+
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
203 doc/T2Flow/Datalink.html
@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: T2Flow::Datalink</title>
+
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/t2flow/model_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/model.rb">lib/t2flow/model.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="../T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="../T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="../T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="../T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="../T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="../T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="../T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="../T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="../T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">T2Flow::Datalink</h1>
+
+ <div id="description">
+ <p>
+This represents a connection between any of the following pair of entities:
+{processor -> processor}, {workflow -> workflow}, {workflow -> processor},
+and {processor -> workflow}.
+</p>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+ <div id="attribute-method-details" class="method-section section">
+ <h3 class="section-header">Attributes</h3>
+
+
+ <div id="source-attribute-method" class="method-detail">
+ <a name="source"></a>
+
+ <a name="source="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">source</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The name of the source (the starting point of the connection).
+</p>
+
+ </div>
+ </div>
+
+ <div id="sink-attribute-method" class="method-detail">
+ <a name="sink"></a>
+
+ <a name="sink="></a>
+
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">sink</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>
+The name of the sink (the endpoint of the connection).
+</p>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- Methods -->
+
+
+ </div>
+
+
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
+
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
+
+</body>
+</html>
+
334 doc/T2Flow/Dot.html
@@ -0,0 +1,334 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+
+ <title>Class: T2Flow::Dot</title>
+
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
+
+</head>
+<body class="class">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/t2flow/dot_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+ class="thickbox" title="lib/t2flow/dot.rb">lib/t2flow/dot.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+ <div id="parent-class-section" class="section">
+ <h3 class="section-header">Parent</h3>
+
+ <p class="link">Object</p>
+
+ </div>
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000026">::is_processor?</a></li>
+
+ <li><a href="#M000005">::new</a></li>
+
+ <li><a href="#M000006">#write_dot</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../LICENCE.html">LICENCE</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../T2Flow/Coordination.html">T2Flow::Coordination</a></li>
+
+ <li><a href="../T2Flow/Dataflow.html">T2Flow::Dataflow</a></li>
+
+ <li><a href="../T2Flow/DataflowAnnotation.html">T2Flow::DataflowAnnotation</a></li>
+
+ <li><a href="../T2Flow/Datalink.html">T2Flow::Datalink</a></li>
+
+ <li><a href="../T2Flow/Dot.html">T2Flow::Dot</a></li>
+
+ <li><a href="../T2Flow/Model.html">T2Flow::Model</a></li>
+
+ <li><a href="../T2Flow/Parser.html">T2Flow::Parser</a></li>
+
+ <li><a href="../T2Flow/Processor.html">T2Flow::Processor</a></li>
+
+ <li><a href="../T2Flow/Sink.html">T2Flow::Sink</a></li>
+
+ <li><a href="../T2Flow/Source.html">T2Flow::Source</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="class">T2Flow::Dot</h1>
+
+ <div id="description">
+ <p>
+This class enables you to write the script will will be used by dot (which
+is part of <a href="http://www.graphviz.org/Download.php">GraphViz</a>) to
+generate the image showing the structure of a given model. To get started
+quickly, you could try:
+</p>
+<pre>
+ out_file = File.new(&quot;path/to/file/you/want/the/dot/script/to/be/written&quot;, &quot;w+&quot;)
+ workflow = File.new(&quot;path/to/workflow/file&quot;, &quot;r&quot;).read
+ model = T2Flow::Parser.new.parse(workflow)
+ T2Flow::Dot.new.write_dot(out_file, model)
+ `dot -Tpng -o&quot;path/to/the/output/image&quot; #{out_file.path}`
+</pre>
+
+ </div>
+
+ <!-- Constants -->
+
+
+ <!-- Attributes -->
+
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
+
+
+ <div id="is-processor--method" class="method-detail ">
+ <a name="M000026"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">is_processor?</span><span
+ class="method-args">(processor_name)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Returns true if the given name is a processor; false otherwise
+</p>
+
+
+
+ <div class="method-source-code"
+ id="is-processor--source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/t2flow/dot.rb, line 244</span>
+244: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Dot</span>.<span class="ruby-identifier">is_processor?</span>(<span class="ruby-identifier">processor_name</span>)
+245: <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@@processor_colours</span>[<span class="ruby-identifier">processor_name</span>]
+246: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="new-method" class="method-detail ">
+ <a name="M000005"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">new</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Creates a new dot object for interaction.
+</p>
+
+
+
+ <div class="method-source-code"
+ id="new-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/t2flow/dot.rb, line 42</span>
+42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+43: <span class="ruby-comment cmt"># @port_style IS CURRENTLY UNUSED. IGNORE!!!</span>
+44: <span class="ruby-ivar">@port_style</span> = <span class="ruby-value str">'none'</span> <span class="ruby-comment cmt"># 'all', 'bound' or 'none'</span>
+45: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+ <div id="public-instance-method-details" class="method-section section">
+ <h3 class="section-header">Public Instance Methods</h3>