Package mmLib :: Module mmCIF :: Class mmCIFFile
[show private | hide private]
[frames | no frames]

Type mmCIFFile

object --+    
         |    
      list --+
             |
            mmCIFFile

Known Subclasses:
mmCIFDictionary

Class representing a mmCIF files.
Method Summary
  __deepcopy__(self, memo)
  __delitem__(self, x)
Remove a mmCIFData by index or data name.
  __eq__(self, other)
  __getattr__(self, name)
  __getitem__(self, x)
Retrieve a mmCIFData object by index or name.
  __str__(self)
  append(self, cdata)
Append a mmCIFData object.
  get(self, x, default)
  get_data(self, name)
Returns the mmCIFData object with the given name.
  has_key(self, x)
  insert(self, i, cdata)
  load_file(self, fil)
Load and append the mmCIF data from file object fil into self.
  new_data(self, name)
Creates a new mmCIFData object with the given name, adds it to this mmCIFFile, and returns it.
  save_file(self, fil)
    Inherited from list
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __add__(x, y)
x.__add__(y) <==> x+y
  __contains__(x, y)
x.__contains__(y) <==> y in x
  __delslice__(x, i, j)
Use of negative indices is not supported.
  __ge__(x, y)
x.__ge__(y) <==> x>=y
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __getslice__(x, i, j)
Use of negative indices is not supported.
  __gt__(x, y)
x.__gt__(y) <==> x>y
  __hash__(x)
x.__hash__() <==> hash(x)
  __iadd__(x, y)
x.__iadd__(y) <==> x+=y
  __imul__(x, y)
x.__imul__(y) <==> x*=y
  __iter__(x)
x.__iter__() <==> iter(x)
  __le__(x, y)
x.__le__(y) <==> x<=y
  __len__(x)
x.__len__() <==> len(x)
  __lt__(x, y)
x.__lt__(y) <==> x<y
  __mul__(x, n)
x.__mul__(n) <==> x*n
  __ne__(x, y)
x.__ne__(y) <==> x!=y
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __repr__(x)
x.__repr__() <==> repr(x)
  __reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
  __rmul__(x, n)
x.__rmul__(n) <==> n*x
  __setitem__(x, i, y)
x.__setitem__(i, y) <==> x[i]=y
  __setslice__(x, i, j, y)
Use of negative indices is not supported.
  count(L, value)
L.count(value) -> integer -- return number of occurrences of value
  extend(...)
L.extend(iterable) -- extend list by appending elements from the iterable
  index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value
  pop(L, index)
L.pop([index]) -> item -- remove and return item at index (default last)
  remove(...)
L.remove(value) -- remove first occurrence of value
  reverse(...)
L.reverse() -- reverse *IN PLACE*
  sort(...)
L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Method Details

__delitem__(self, x)
(Index deletion operator)

Remove a mmCIFData by index or data name. Raises IndexError or KeyError if the mmCIFData object is not found, the error raised depends on the argument type.
Overrides:
__builtin__.list.__delitem__

__getitem__(self, x)
(Indexing operator)

Retrieve a mmCIFData object by index or name.
Overrides:
__builtin__.list.__getitem__

append(self, cdata)

Append a mmCIFData object. This will trigger the removal of any mmCIFData object in the file with the same name.
Overrides:
__builtin__.list.append

get_data(self, name)

Returns the mmCIFData object with the given name. Returns None if no such object exists.

load_file(self, fil)

Load and append the mmCIF data from file object fil into self. The fil argument must be a file object or implement its iterface.

new_data(self, name)

Creates a new mmCIFData object with the given name, adds it to this mmCIFFile, and returns it.

Generated by Epydoc 2.1 on Sun Apr 23 22:08:39 2006 http://epydoc.sf.net