pscfpp.text.RecordEditor Class Reference

Class to modify selected Records in a file of records. More...

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	setFilter (self, filter, field=0)
	Set filter string. More...
def	setNew (self, new, field)
	Set new string. More...
def	setIsTest (self, isTest)
	Set isTest flag, to decide whether to perform a dry run. More...
def	editFile (self, filename)
	Open and edit the specified file of records. More...

Detailed Description

Class to modify selected Records in a file of records.

The editFile function searches for records in which one field matches a regular expression, and resets the value of another.

Definition at line 144 of file text.py.

Constructor & Destructor Documentation

__init__()

def pscfpp.text.RecordEditor.__init__

(

self

)

Constructor.

Definition at line 149 of file text.py.

References pscfpp.text.RecordEditor.hasFilter, pscfpp.text.FileEditor.hasFilter, pscfpp.text.RecordEditor.hasNew, pscfpp.text.FileEditor.hasNew, pscfpp.text.RecordEditor.isReady, pscfpp.text.FileEditor.isReady, Pscf::PropagatorTmpl< Propagator >.isReady(), Pscf::PropagatorTmpl< TP >.isReady(), Pscf::PropagatorTmpl< Propagator< D > >.isReady(), pscfpp.make.MakeMaker.isTest, pscfpp.text.RecordEditor.isTest, and pscfpp.text.FileEditor.isTest.

Member Function Documentation

setFilter()

def pscfpp.text.RecordEditor.setFilter	(		self,
			filter,
			field = 0
	)

Set filter string.

Parameters

filter	regular expression string
field	index of field to be searched for (filter)

Definition at line 161 of file text.py.

References pscfpp.text.RecordEditor.filter, pscfpp.text.FileEditor.filter, pscfpp.text.RecordEditor.filterField, pscfpp.text.RecordEditor.hasFilter, pscfpp.text.FileEditor.hasFilter, pscfpp.text.RecordEditor.hasNew, pscfpp.text.FileEditor.hasNew, pscfpp.text.RecordEditor.isReady, pscfpp.text.FileEditor.isReady, Pscf::PropagatorTmpl< Propagator >.isReady(), Pscf::PropagatorTmpl< TP >.isReady(), and Pscf::PropagatorTmpl< Propagator< D > >.isReady().

setNew()

def pscfpp.text.RecordEditor.setNew	(		self,
			new,
			field
	)

Set new string.

Parameters

new	new value for field
field	index of field to be modified

Definition at line 174 of file text.py.

References pscfpp.text.RecordEditor.dataField, pscfpp.text.RecordEditor.hasFilter, pscfpp.text.FileEditor.hasFilter, pscfpp.text.RecordEditor.hasNew, pscfpp.text.FileEditor.hasNew, pscfpp.text.RecordEditor.isReady, pscfpp.text.FileEditor.isReady, Pscf::PropagatorTmpl< Propagator >.isReady(), Pscf::PropagatorTmpl< TP >.isReady(), Pscf::PropagatorTmpl< Propagator< D > >.isReady(), pscfpp.text.RecordEditor.new, and pscfpp.text.FileEditor.new.

setIsTest()

def pscfpp.text.RecordEditor.setIsTest	(		self,
			isTest
	)

Set isTest flag, to decide whether to perform a dry run.

Parameters

isTest

if true, perform a dry run (no modificatin)

Definition at line 186 of file text.py.

References pscfpp.make.MakeMaker.isTest, pscfpp.text.RecordEditor.isTest, and pscfpp.text.FileEditor.isTest.

editFile()

def pscfpp.text.RecordEditor.editFile	(		self,
			filename
	)

Open and edit the specified file of records.

Parameters

filename

name of file

Definition at line 194 of file text.py.

References pscfpp.text.RecordEditor.dataField, pscfpp.text.RecordEditor.filter, pscfpp.text.FileEditor.filter, pscfpp.text.RecordEditor.filterField, pscfpp.text.RecordEditor.isReady, pscfpp.text.FileEditor.isReady, Pscf::PropagatorTmpl< Propagator >.isReady(), Pscf::PropagatorTmpl< Propagator< D > >.isReady(), Pscf::PropagatorTmpl< TP >.isReady(), pscfpp.make.MakeMaker.isTest, pscfpp.text.RecordEditor.isTest, pscfpp.text.FileEditor.isTest, pscfpp.text.RecordEditor.new, and pscfpp.text.FileEditor.new.

---

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

• text.py