Class SizedString

            object --+        
                     |        
utils.graph.DetailNode --+    
                         |    
       xml.basic.BasicBase --+
                             |
            object --+       |
                     |       |
 editable.EditableBase --+   |
                         |   |
 editable.EditableLineEdit --+
                             |
                            SizedString

Known Subclasses:

Basic type for strings. The type starts with an unsigned int which describes the length of the string.

>>> from tempfile import TemporaryFile
>>> f = TemporaryFile()
>>> from pyffi.object_models import FileFormat
>>> data = FileFormat.Data()
>>> s = SizedString()
>>> if f.write('\x07\x00\x00\x00abcdefg'.encode("ascii")): pass # ignore result for py3k
>>> if f.seek(0): pass # ignore result for py3k
>>> s.read(f, data)
>>> str(s)
'abcdefg'
>>> if f.seek(0): pass # ignore result for py3k
>>> s.set_value('Hi There')
>>> s.write(f, data)
>>> if f.seek(0): pass # ignore result for py3k
>>> m = SizedString()
>>> m.read(f, data)
>>> str(m)
'Hi There'

Instance Methods

[hide private]

__init__(self, **kwargs)
Initialize the string.

source code

get_value(self)
Return the string.

source code

set_value(self, value)
Set string to C{value}.

source code

__str__(self)
Return string representation.

source code

get_size(self, data=None)
Return number of bytes this type occupies in a file.

source code

get_hash(self, data=None)
Return a hash value for this string.

source code

read(self, stream, data)
Read string from stream.

source code

write(self, stream, data)
Write string to stream.

source code

Inherited from xml.basic.BasicBase: fix_links, get_detail_display, get_editor_value, get_links, get_refs, get_strings, 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]

Inherited from xml.basic.BasicBase: arg

Inherited from xml.basic.BasicBase (private): _has_links, _has_refs, _has_strings, _is_template

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **kwargs)
(Constructor)

source code

Initialize the string.

Parameters:

template - type used as template
argument - argument used to initialize the instance (see the Struct class).
parent - The parent of this instance, that is, the instance this instance is an attribute of.

Overrides: object.__init__