Changes between Version 7 and Version 8 of TopdlLibrary

Timestamp:

Oct 5, 2012 4:11:18 PM (12 years ago)

Author:

faber

Comment:

--

TopdlLibrary

@@ -193 +193 @@
 Because the enclosing {{{Topology}}} object maintains the {{{interfaces}}} member, it is dangerous to have the same {{{Substrate}}} object in more than one {{{Topology}}}.  Use the {{{clone()}}} method to avoid this.
 
+== CPU Class ==
+
+This represents a CPU on a computer.  It has the following members:
+
+ {{{type}}}::
+  A string indicating the type of CPU.  These are not yet standardized, but common formats like "i686" or "amd64" are used.
+ {{{attribute}}}::
+   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the substrate.  The list may be empty.
+
+The constructor takes the member names as named parameters.
+
+== !OperatingSystem Class ==
+
+This class captures the operating system requirements of a computer.  It has the following members:
+
+ {{{name}}}::
+  A string naming the operating system required.  This is usually the operating system itself, e.g., Linux, FreeBSD, Windows XP.  This may be None, indicating no preference or information.
+ {{{version}}}::
+  A string identifying the version of the OS.  For integrates systems like FreeBSD this is the system version.  For distribution-based systems like Linux, this is the kernel version.  See below for distribution versioning.  This may be None, indicating no version information or preference.
+ {{{distribution}}}::
+  A string that for operating systems that characterize OS distribution independently of kernel or base system, names the distribution in use, e.g., Ubuntu. This may be None, indicating no information or preference.
+ {{{distributionversion}}}::
+  A string that for operating systems that characterize OS distribution independently of kernel or base system, names the version of the distribution in use, e.g., 12.04 for Ubuntu. This may be None, indicating no information or preference.
+
+The constructor takes the member names as parameters.  Note that all the members may be None, but an empty {{{!OperatingSystem}}} object is not very useful.  The flexibility is there to allow specifying an operating system version without a distribution or a distribution without a base version.
+
+== Storage Class ==
+
+The storage requirements or information for a system.  This class characterizes memory or permanent storage.  Its members are:
+
+ {{{amount}}}::
+  A floating point value indicating the number of megabytes of storage being considered.  Values less than 0.000001 are treated as 0.
+ {{{persistence}}::
+  A boolean value indicating whether this is persistent storage, such as a disk or SSD, or volitile such as memory.  
+ {{{attribute}}}::
+   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the machine.  The list may be empty.
+
+Currently there is no field for media type.  Use attributes.
+
+The constructor takes the member names as named parameters.
+
+== Software Class ==
+
+This indicates what software must be installed on a system.  Its members are:
+
+ {{{location}}}::
+  A string containing a URI from which to install the software, e.g., a file: URI pointing to a tarfile.
+ {{{install}}}::
+   A string containing location in the local file system to base the software install.  This may be None, indicating that the software distribution format includes this information, e.g., an rpm or debian software file.
+
+The constructor takes the member names as named parameters.
+
+
 
 = Examples =