Package pyffi :: Package formats :: Package nif :: Class NifFormat :: Class string
[hide private]
[frames] | no frames]

Class string

source code

                         object --+            
                                  |            
             utils.graph.DetailNode --+        
                                      |        
      object_models.xml.basic.BasicBase --+    
                                          |    
                         object --+       |    
                                  |       |    
object_models.editable.EditableBase --+   |    
                                      |   |    
object_models.editable.EditableLineEdit --+    
                                          |    
           object_models.common.SizedString --+
                                              |
                                             NifFormat.string
Known Subclasses:

Instance Methods [hide private]
 
get_size(self, data=None)
Return number of bytes this type occupies in a file.
source code
 
read(self, stream, data)
Read string from stream.
source code
 
write(self, stream, data)
Write string to stream.
source code
 
get_strings(self, data)
Return all strings used by this object.
source code
 
get_hash(self, data=None)
Return a hash value for this string.
source code

Inherited from object_models.common.SizedString: __init__, __str__, get_value, set_value

Inherited from object_models.xml.basic.BasicBase: fix_links, get_detail_display, get_editor_value, get_links, get_refs, replace_global_node, set_editor_value

Inherited from utils.graph.DetailNode: get_detail_child_edge_types, get_detail_child_names, get_detail_child_nodes, get_detail_iterator

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

Class Variables [hide private]
  _has_strings = True

Inherited from object_models.xml.basic.BasicBase: arg

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get_size(self, data=None)

source code 
Return number of bytes this type occupies in a file.
Returns:
Number of bytes.
Overrides: object_models.xml.basic.BasicBase.get_size
(inherited documentation)

read(self, stream, data)

source code 
Read string from stream.
Parameters:
  • stream - The stream to read from.
Overrides: object_models.xml.basic.BasicBase.read
(inherited documentation)

write(self, stream, data)

source code 
Write string to stream.
Parameters:
  • stream - The stream to write to.
Overrides: object_models.xml.basic.BasicBase.write
(inherited documentation)

get_strings(self, data)

source code 
Return all strings used by this object.
Overrides: object_models.xml.basic.BasicBase.get_strings
(inherited documentation)

get_hash(self, data=None)

source code 
Return a hash value for this string.
Returns:
An immutable object that can be used as a hash.
Overrides: object_models.xml.basic.BasicBase.get_hash
(inherited documentation)