Changes between Version 10 and Version 11 of TopdlLibrary

Timestamp:

Oct 5, 2012 4:42:21 PM (12 years ago)

Author:

faber

Comment:

--

TopdlLibrary

@@ -175 +175 @@
    A list of strings giving alternative names for the object.  The list may be empty, meaning no such alternatives exist.
  {{{status}}}::
-   A string indicating the current status of the Computer (if any).  It may also be None, indicating no status is reported. Valid values are
+   A string indicating the current status of the Substrate (if any).  It may also be None, indicating no status is reported. Valid values are
      * "empty" - no allocation of resources has been attempted - generally not applied to Substrates
      * "active" - Substrate is functioning as part of an experiment
@@ -280 +280 @@
 The constructor takes the member names as named parameters.
 
+== Service Class ==
+
+A service class encapsulates the ideas of a [FeddAbout#ExperimentServices DETER federation service].  Such services can be available from or used by a variety of topology elements.  The Service class has the following members:
+
+ {{{name}}}::
+  The name of the service.  A few [FeddAbout#ExperimentServices are defined].
+ {{{importer}}}::
+  A list of entity names that are using or requesting the service.  This list may be empty.
+ {{{param}}}::
+  A list of [TopdlLibrary#ServiceParamClass ServiceParam objects] that represent typed parameters to the service.  The list may be empty.
+ {{{description}}}::
+  A string describing the service.  This may be None.
+ {{{status}}}::
+  A string describing the current status of the service (if any).  It may also be None, indicating no status is reported. Valid values are
+     * "empty" - no allocation of resources has been attempted - generally not applied to Services
+     * "active" - Service is functioning as part of an experiment
+     * "inactive" - Service is allocated, but not functioning
+     * "starting" - Service is transitioning from "inactive" to "active"
+     * "terminating" - Service is transitioning from "active" to "inactive"
+     * "failed" - an allocation of resources has failed - generally not applied to Services
+
+The constructor will take the member names as named parameters.
+
+== !ServiceParam Class ==
+
+A description of the type of parameter to a [TopdlLibrary#ServiceClass Service] will accept.  It has the following members:
+
+ {{{name}}}::
+   Name of the parameter, a string.
+ {{{type}}}::
+   A string containing the type of the parameter.  Valid types are:
+    * string
+    * int
+    * float
+
+The constructor will take the member names as named parameters.