Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Package pyffi :: Package formats :: Package esp :: Class EspFormat :: Class Data
[hide private]
[frames] | no frames]

Class Data

source code

            object --+            
                     |            
utils.graph.DetailNode --+        
                         |        
    utils.graph.GlobalNode --+    
                             |    
 object_models.FileFormat.Data --+
                                 |
                                EspFormat.Data
A class to contain the actual esp data.
Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
inspect_quick(self, stream)
Quickly checks if stream contains ESP data, and gets the version, by looking at the first 8 bytes.		 source code
 
inspect(self, stream)
Quickly checks if stream contains ESP data, and reads the header.		 source code
 
read(self, stream)
Read a esp file.		 source code
 
write(self, stream)
Write a esp file.		 source code
generator yielding DetailNodes
get_detail_child_nodes(self, edge_filter=(True, True))
Generator which yields all children of this item in the detail view (by default, all acyclic and active ones).		 source code
generator yielding strs
get_detail_child_names(self, edge_filter=(True, True))
Generator which yields all child names of this item in the detail view.		 source code
 
get_global_child_nodes(self, edge_filter=(True, True))
Generator which yields all children of this item in the global view, of given edge type (default is edges of type 0).		 source code

Inherited from utils.graph.GlobalNode: get_global_child_edge_types, get_global_display, get_global_iterator

Inherited from utils.graph.DetailNode: get_detail_child_edge_types, get_detail_display, get_detail_iterator, replace_global_node

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from object_models.FileFormat.Data: user_version, version

Inherited from object_models.FileFormat.Data (private): _byte_order

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
x.__init__(...) initializes x; see help(type(x)) for signature
Overrides: object.__init__
(inherited documentation)

inspect_quick(self, stream)

source code 
Quickly checks if stream contains ESP data, and gets the version, by looking at the first 8 bytes.
Parameters:
  • stream (file) - The stream to inspect.

inspect(self, stream)

source code 
Quickly checks if stream contains ESP data, and reads the header.
Parameters:
  • stream (file) - The stream to inspect.
Returns:
True if stream is of particular format, False otherwise.
Overrides: object_models.FileFormat.Data.inspect

read(self, stream)

source code 
Read a esp file.
Parameters:
  • stream (file) - The stream from which to read.
Overrides: object_models.FileFormat.Data.read

write(self, stream)

source code 
Write a esp file.
Parameters:
  • stream (file) - The stream to which to write.
Overrides: object_models.FileFormat.Data.write

get_detail_child_nodes(self, edge_filter=(True, True))

source code 

Generator which yields all children of this item in the detail view (by default, all acyclic and active ones).

Override this method if the node has children.

Parameters:
  • edge_filter - The edge type to include.
Returns: generator yielding DetailNodes
Generator for detail tree child nodes.
Overrides: utils.graph.DetailNode.get_detail_child_nodes
(inherited documentation)

get_detail_child_names(self, edge_filter=(True, True))

source code 

Generator which yields all child names of this item in the detail view.

Override this method if the node has children.

Returns: generator yielding strs
Generator for detail tree child names.
Overrides: utils.graph.DetailNode.get_detail_child_names
(inherited documentation)

get_global_child_nodes(self, edge_filter=(True, True))

source code 

Generator which yields all children of this item in the global view, of given edge type (default is edges of type 0).

Override this method.

Returns:
Generator for global node children.
Overrides: utils.graph.GlobalNode.get_global_child_nodes
(inherited documentation)

   Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Generated by Epydoc 3.0.1 on Mon Oct 10 19:03:31 2011 http://epydoc.sourceforge.net