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

Class LineString

source code

                   object --+        
                            |        
       utils.graph.DetailNode --+    
                                |    
object_models.xml.basic.BasicBase --+
                                    |
                                   NifFormat.LineString

Basic type for strings ending in a newline character (0x0a).

>>> from tempfile import TemporaryFile
>>> f = TemporaryFile()
>>> l = NifFormat.LineString()
>>> f.write('abcdefg\x0a'.encode())
>>> f.seek(0)
>>> l.read(f)
>>> str(l)
'abcdefg'
>>> f.seek(0)
>>> l.set_value('Hi There')
>>> l.write(f)
>>> f.seek(0)
>>> m = NifFormat.LineString()
>>> m.read(f)
>>> str(m)
'Hi There'
Instance Methods [hide private]
 
__init__(self, **kwargs)
Initializes the instance.
source code
 
get_value(self)
Return object value.
source code
 
set_value(self, value)
Set object value.
source code
 
__str__(self)
Return string representation.
source code
 
get_size(self, data=None)
Returns size of the object in bytes.
source code
 
get_hash(self, data=None)
Returns a hash value (an immutable object) that can be used to identify the object uniquely.
source code
 
read(self, stream, data=None)
Read object from file.
source code
 
write(self, stream, data=None)
Write object to file.
source code

Inherited from object_models.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 object_models.xml.basic.BasicBase: arg

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

source code 
Initializes the instance.
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__
(inherited documentation)

get_value(self)

source code 
Return object value.
Overrides: object_models.xml.basic.BasicBase.get_value
(inherited documentation)

set_value(self, value)

source code 
Set object value.
Overrides: object_models.xml.basic.BasicBase.set_value
(inherited documentation)

__str__(self)
(Informal representation operator)

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

get_size(self, data=None)

source code 
Returns size of the object in bytes.
Overrides: object_models.xml.basic.BasicBase.get_size
(inherited documentation)

get_hash(self, data=None)

source code 
Returns a hash value (an immutable object) that can be used to identify the object uniquely.
Overrides: object_models.xml.basic.BasicBase.get_hash
(inherited documentation)

read(self, stream, data=None)

source code 
Read object from file.
Overrides: object_models.xml.basic.BasicBase.read
(inherited documentation)

write(self, stream, data=None)

source code 
Write object to file.
Overrides: object_models.xml.basic.BasicBase.write
(inherited documentation)