Changes between Version 12 and Version 13 of TopdlLibrary
- Timestamp:
- Oct 8, 2012 9:20:21 AM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TopdlLibrary
v12 v13 33 33 34 34 * [TopdlLibrary#ComputerClass Computer] 35 * CPU(0 or more)36 * Attribute(0 or more)37 * !OperatingSystem(0 or more)38 * Attribute39 * Software(0 or more)40 * Attribute(0 or more)41 * Storage42 * Attribute43 * Interface(0 or more)44 * Capacity(0 or 1)45 * Latency(0 or 1)46 * Attribute(0 or more)47 * Service(0 or more)48 * !ServiceParam(0 or more)35 * [TopdlLibrary#CPUClass CPU] (0 or more) 36 * [TopdlLibrary#AttributeClass Attribute] (0 or more) 37 * [TopdlLibrary#OperatingSystemClass !OperatingSystem] (0 or more) 38 * [TopdlLibrary#AttributeClass Attribute] (0 or more) 39 * [TopdlLibrary#SoftwareClass Software] (0 or more) 40 * [TopdlLibrary#AttributeClass Attribute] (0 or more) 41 * [TopdlLibrary#StorageClass Storage] (0 or more) 42 * [TopdlLibrary#AttributeClass Attribute] (0 or more) 43 * [TopdlLibrary#InterfaceClass Interface] (0 or more) 44 * [TopdlLibrary#CapacutyClass Capacity] (0 or 1) 45 * [TopdlLibrary#LatencyClass Latency] (0 or 1) 46 * [TopdlLibrary#AttributeClass Attribute] (0 or more) 47 * [TopdlLibrary#ServiceClass Service] (0 or more) 48 * [TopdlLibrary#ServiceParamClass !ServiceParam] (0 or more) 49 49 50 50 Most classes can have attributes attached to them that contain extention attributes that different applications make use of. The presence or absence of an optional nested object does not mean the presence or absence of the thing it describes, but that the description is unbound. As [TopDl#Representation we have seen] a Computer without a nested CPU object does not describe a computer without a CPU, but a computer with no constraints on the CPU. 51 51 52 == Adaptive Constructors==52 === Adaptive Constructors === 53 53 54 54 The constructors of the various topdl classes will accept contained classes in several formats. They will always accept an object of the relevant class. They will also take a dict that maps constructor parameters to values for the given class. Examples make this clearer than description. … … 77 77 All topdl class constructors take the member names as parameters, and should be called using named parameters, as above. The only exceptions to this is the [TopdlLibrary#SubstrateClass Substrate object]'s {{{interfaces}}} member and the [TopdlLibrary#InterfaceClass Interface object]'s {{{subs}}} member. An Interface's {{{element}}} member can be specified, but generally is not. 78 78 79 == Topdl Class Features==79 === Topdl Class Features === 80 80 81 81 All topdl classes implement the following methods: … … 95 95 Return the XML encoding (from the topdl language) of this object (and nested objects) 96 96 97 == Topology Class==97 === Topology Class === 98 98 99 99 This class holds an enitre topology. The utility functions that read and write files operate on it, and it is generally the unit of I/O for the library. … … 122 122 {{{incorporate_elements()}}} is called by the {{{Topology}}} constructor as well and that constructor may throw the same exceptions. 123 123 124 == Computer Class==124 === Computer Class === 125 125 126 126 A Computer object is a programmable computer in a topology. A webserver is well represented by a computer, as is a desktop. … … 158 158 A {{{Computer}}} should only be an element of one {{{Topology}}}. Use {{{clone()}}} to avoid this. 159 159 160 == Substrate Class==160 === Substrate Class === 161 161 162 162 The {{{Substrate}}} object represents a communication substrate. The elements that have interfaces connected to a substrate can communicate with one another. A {{{Substrate}}} may include default parameters for the latency and capacity of the communication channel. … … 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. 194 194 195 == Interface Class==195 === Interface Class === 196 196 197 197 This class defines the attachment of an entity, e.g., a [TopdlLibrary#ComputerClass Computer], to a [TopdlLibrary#SubstrateClass Substrate]. As with Substrates and entities, each Interface should be attached to only one entity and be unique across a [TopdlLibrary#Topology Topology]. An Interface has the following members: … … 212 212 The constructor takes all the member names '''except subs''' as parameters. Most programs will not need to use {{{element}}} as a parameter to the constructor, either. 213 213 214 == Attribute Class==214 === Attribute Class === 215 215 216 216 An attribute is a user-defined annotation of one of the other classes: a key/value pair. An attribute has the following members: … … 225 225 Should a program need to call the constructor, it takes the member names as named parameters. 226 226 227 == CPU Class==227 === CPU Class === 228 228 229 229 This represents a CPU on a computer. It has the following members: … … 236 236 The constructor takes the member names as named parameters. 237 237 238 == !OperatingSystem Class==238 === !OperatingSystem Class === 239 239 240 240 This class captures the operating system requirements of a computer. It has the following members: … … 254 254 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. 255 255 256 == Storage Class==256 === Storage Class === 257 257 258 258 The storage requirements or information for a system. This class characterizes memory or permanent storage. Its members are: … … 269 269 The constructor takes the member names as named parameters. 270 270 271 == Software Class==271 === Software Class === 272 272 273 273 This indicates what software must be installed on a system. Its members are: … … 280 280 The constructor takes the member names as named parameters. 281 281 282 == Service Class==282 === Service Class === 283 283 284 284 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: … … 303 303 The constructor will take the member names as named parameters. 304 304 305 == !ServiceParam Class==305 === !ServiceParam Class === 306 306 307 307 A description of the type of parameter to a [TopdlLibrary#ServiceClass Service] will accept. It has the following members: … … 317 317 The constructor will take the member names as named parameters. 318 318 319 == Testbed Class==319 === Testbed Class === 320 320 321 321 This class represents a testbed that has allocated resources or from which an allocation is requested. While it is primarily used internally by the federation system, some other applications include a {{{Testbed}}} as a place to attach attributes that pertain to the whole topology. … … 348 348 The constructor takes the member names as named parameters. 349 349 350 == Segment Class==350 === Segment Class === 351 351 352 352 This class represents a sub-experiment of a federated experiment about which the details are unknown except for its interfaces. It is primarily used internally by teh federation system. … … 363 363 A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the segment. The list may be empty. 364 364 365 == ID Class==365 === ID Class === 366 366 367 367 This class represents a polymorphic identifier as used by the federation system. At most one of its members is set. … … 382 382 The constructor accepts the member names as named parameters. 383 383 384 == Other Class==384 === Other Class === 385 385 386 386 This class represents a topology element that is not captured above. It is a set of interfaces and a place to hang attributes, for use encoding kinds of elements unknown when topdl was specified.
