Changes between Version 12 and Version 13 of LayoutAspect

Timestamp:

Jul 8, 2014 6:00:57 PM (10 years ago)

Author:

faber

Comment:

--

LayoutAspect

@@ -171 +171 @@
 === Topology Calls to the Experiment API ===
 
-Researchers interested inworking with experiment topologies can make the following calls on the Experiment API.
+Researchers interested in working with experiment topologies manipulate the topology aspect of an experiment.  It is possible to have multiple topology definitions for an experiment that are divided into regions differently, as long as they all are isomorphic.
 
- * getViews(ExperimentName)
+When a topology aspect is added, the testbed generates aspects of type topology and the following subtypes.  This happens whether the topology aspect is added using `experimentCreate()` or `addExperimentAspect()`.
 
-ExperimentName is a string returned from viewExperiments. Returns a list of string pairs, the first being the name of a topology view and the second being a short description of the view.
+ full_topology::
+  The topology with all regions expanded.  The name is the topology aspect with "/full_topology" appended.
+ minimal_topology::
+  The topology with no regions expanded and no fragments or namemaps attached.  This is the quickest and dirtiest topology available for visualization.  The name is the topology aspect with "/minimal_topology" appended.
+ fragment::
+  A fragment of the given topology.  The name is the aspect name with "/" and the name of the fragment appended.  These are used to incrementally expand a minimal_topology
+ namemap::
+  A namemap from the topology expansion.  The name is the aspect name with the namemap pathname appended. These are used to incrementally expand a minimal_topology
 
- * getTopology(ExperimentName, ViewName)
-
-ExperimentName is a string from viewExperiments, and ViewName is a string from getViews. Returns a topdl v2 file containing the initial topology.
-
- * getFragment(ExperimentName, ViewName, FragmentName)
-
-ExperimentName is a string from viewExperiments, and ViewName is a string from getViews.  Returns a topdl v2 file without elements or substrates, but with at least the requested fragment. It may also include other fragments and name maps.
-
- * addView(ExperimentName, ViewName, topdl)
-
-ExperimentName is the name of an existing experiment, from viewExperiments, and topdl is a new view of that experiment.  If the testbed can determine that the view describes the same topology as the experiment currently has, the new view will be added with viewName as the name.  If the topology does not match, or the testbed cannot determine that it does so, an error will be returned.  Topdl is a the new view encoded in topdl.  There will be a version of this that can retrieve the topdl from a URL as well.
-
- * removeView(ExperimentName, ViewName)
-
-ExperimentName is a string from viewExperiments, and ViewName is a string from getViews. Remove the given view from the experiment.  Will fail if the view is the last one.
-
+A new version of the topology can be added at any time using `addExperimentAspect()`, but the call will fail topologies that are not isomorphic to the experiment's current topology aspect.  Adding a topology to an experiment without a topology aspect always succeeds.
+