Changes between Version 3 and Version 4 of TopdlLibrary

Timestamp:

Oct 5, 2012 11:35:00 AM (12 years ago)

Author:

faber

Comment:

--

TopdlLibrary

@@ -73 +73 @@
 }}}
 
-That is, inner class parameters can be specified using dicts directly, and a top level dict can user the standard ** operator.
+That is, inner class parameters can be specified using dicts directly, and a top level dict can user the standard ** operator
 
+== Topdl Class Features ==
+
+All topdl classes implement the following methods:
+
+ {{{set_attribute(self, key, value)}}}::
+   Attach an user-defined attribute with the given key and value to this object; value and key are strings.  The method includes a key/value pair (encoded as an [TopdlLibrary#Attribute attribute object]) into the {{{attribute}}} member of the object.  If an attribute with the given key exists, it is overwritten. 
+   This method accesses the attribute member of the given object, not any named members. Objects that do not have an {{{attribute}}} member silently discard the operation.
+ {{{get_attribute(self, key)}}}::
+   Return the attribute of this object with the given key.  The attribute - a string - is returned.  If no such attribute exists, or the object has no {{{attribute}}} member, return None.
+ {{{remove_attribute(self, key)}}}::
+   If an attribute with the given key exists, remove it.
+ {{{clone(self)}}}::
+   Returns a deep copy of this object.
+ {{{to_dict(self)}}}::
+   Return the object as a python dict.  No copies are made, so make modifications with caution.
+ {{{to_xml(self)}}}::
+   Return the XML encoding (from the topdl language) of this object (and nested objects)
 
 == Computer Class ==
@@ -108 +125 @@
    A list of strings that describe the valid operations on the machine.  These are generally used by the federation system, and their definition is somewhat in flux.The list may be empty.
 
+
+
 = Examples =