pyffi :: object_models :: common :: Char :: Class Char
[hide private]
[frames] | no frames]

Class Char

source code

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

Implementation of an (unencoded) 8-bit character.
Instance Methods [hide private]
 
__init__(self, **kwargs)
Initialize the character.
source code
 
get_value(self)
Return stored value.
source code
 
set_value(self, value)
Set character to C{value}.
source code
 
read(self, stream, data)
Read value from stream.
source code
 
write(self, stream, data)
Write value to stream.
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 value.
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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

source code 
Initialize the character.
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__

get_value(self)

source code 
Return stored value.
Returns:
The stored value.
Overrides: xml.basic.BasicBase.get_value

set_value(self, value)

source code 
Set character to C{value}.
Parameters:
  • value (bytes) - The value to assign (bytes of length 1).
Overrides: xml.basic.BasicBase.set_value

read(self, stream, data)

source code 
Read value from stream.
Parameters:
  • stream (file) - The stream to read from.
Overrides: xml.basic.BasicBase.read

write(self, stream, data)

source code 
Write value to stream.
Parameters:
  • stream (file) - The stream to write to.
Overrides: xml.basic.BasicBase.write

__str__(self)
(Informal representation operator)

source code 
Return string representation.
Overrides: object.__str__
(inherited documentation)

get_size(self, data=None)

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

get_hash(self, data=None)

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