Class CgfSpell

object --+    
         |    
     Spell --+
             |
            CgfSpell

Known Subclasses:

Base class for spells for cgf files.

Instance Methods

[hide private]

bool

_datainspect(self)
This is called after pyffi.object_models.FileFormat.Data.inspect has been called, and before pyffi.object_models.FileFormat.Data.read is called.

source code

bool

inspectblocktype(self, block_type)
This function heuristically checks whether the given block type is used in the cgf file, using header information only.

source code

Inherited from Spell: __init__, branchentry, branchexit, branchinspect, dataentry, dataexit, datainspect, recurse

Inherited from Spell (private): _branchinspect

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

Class Methods

[hide private]

Inherited from Spell: get_toast_stream, toastentry, toastexit

Class Variables

[hide private]

Inherited from Spell: READONLY, SPELLNAME, changed, data, stream, toaster

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

_datainspect(self)

source code

This is called after pyffi.object_models.FileFormat.Data.inspect has been called, and before pyffi.object_models.FileFormat.Data.read is called.

Returns: bool: True if the file must be processed, False otherwise.
Overrides: Spell._datainspect: (inherited documentation)

inspectblocktype(self, block_type)

source code

This function heuristically checks whether the given block type is used in the cgf file, using header information only. When in doubt, it returns True.

Parameters:

block_type (L{CgfFormat.Chunk}) - The block type.

Returns: bool

False if the cgf has no block of the given type, with certainty. True if the cgf has the block, or if it cannot be determined.

Home

Trees

Indices

Help