blockit::Fortran::library::FortranLibrary Class Reference

Inheritance diagram for blockit::Fortran::library::FortranLibrary:

Collaboration diagram for blockit::Fortran::library::FortranLibrary:

List of all members.

Public Member Functions
def	__init__
def	getFile
def	storeFile
def	getTemplate
def	storeTemplate
def	storeHashTable
def	getHashTable
def	storeSymbolTable
def	getSymbolTable
def	__iadd__
def	genKey
Static Public Attributes
string	VERSION = '1.4'
Private Member Functions
def	_upgradeLib

---

Detailed Description

Extends blockit.library.Library class to include template storage.

Definition at line 110 of file library.py.

---

Constructor & Destructor Documentation

def blockit::Fortran::library::FortranLibrary::__init__	(		self,
			name,
			blockList
	)

Library constructor

Input
-----
name : library file name
blockList : list of block types for use with library.  This is needed
    for block reconstruction.

Reimplemented from blockit::library::Library.

Definition at line 116 of file library.py.

---

Member Function Documentation

def blockit::Fortran::library::FortranLibrary::__iadd__	(		self,
			other
	)

Intelligently merge two FortranLibrary instances.  

Reimplemented from blockit::library::Library.

Definition at line 237 of file library.py.

def blockit::Fortran::library::FortranLibrary::_upgradeLib

(

self

)

[private]

Function called when a library version number is less than the the
current codes version number for the library.

Reimplemented from blockit::library::Library.

Definition at line 228 of file library.py.

def blockit::Fortran::library::FortranLibrary::genKey

(

blk

)

Static method to generate an instantiated Template block key for
the library.  The key is generated from the parent file's hash as
follows: 

<parent file hash value>/templates

Input
-----
blk : an instantiated template block

Reimplemented from blockit::library::Library.

Definition at line 244 of file library.py.

def blockit::Fortran::library::FortranLibrary::getFile	(		self,
			name,
			hsh,
			checkHash = True
	)

Gets a File block from the database.

name : the file name
hsh : the hash of the file to check against the one stored in the
      library.

Definition at line 119 of file library.py.

def blockit::Fortran::library::FortranLibrary::getHashTable

(

self

)

Retrieve the file hash table from the library.

Definition at line 205 of file library.py.

def blockit::Fortran::library::FortranLibrary::getSymbolTable

(

self

)

Retrieve the symbol table from the library.

Definition at line 222 of file library.py.

def blockit::Fortran::library::FortranLibrary::getTemplate	(		self,
			name
	)

Get an instantiated template from the library.

Definition at line 163 of file library.py.

def blockit::Fortran::library::FortranLibrary::storeFile	(		self,
			blk
	)

Saves a AFile block to the database.

Definition at line 144 of file library.py.

def blockit::Fortran::library::FortranLibrary::storeHashTable	(		self,
			table
	)

Store dictionary of filenames and their hash values.

Definition at line 194 of file library.py.

def blockit::Fortran::library::FortranLibrary::storeSymbolTable	(		self,
			table
	)

Store dictionary of all the symbols.

Definition at line 211 of file library.py.

def blockit::Fortran::library::FortranLibrary::storeTemplate	(		self,
			blk
	)

Store an instantiated template in the library

Definition at line 172 of file library.py.

---

Member Data Documentation

string blockit::Fortran::library::FortranLibrary::VERSION = '1.4' [static]

Reimplemented from blockit::library::Library.

Definition at line 115 of file library.py.

---

The documentation for this class was generated from the following file:

• blockit/Fortran/library.py