Table of Contents

Class: FtuFttFileAction FtuFttFileAction.py

Base class for Filename (Manipulation) Actions.

Base Classes   
FtuFttActionBase
Methods   
__init__
_setFileAction
_setFileActionFromFtt
dump
dumpBuf
getPrefix
isDefined
setPrefix
  __init__ 
__init__ (
        self,
        prefix="",
        valueSrcList=None,
        )

Constructor method initializing the object class variables.

prefix: Prefix/base for the File Action. This corresponds to to FILE.PATH.BASE or FILE.RENAME.PREFIX.

valueSrcList List of FtuFttValueSrc objects.

  _setFileAction 
_setFileAction (
        self,
        prefix,
        valueSrcList=None,
        )

Set the File Action for the

prefix: Prefix/base for the File Action.

valueSrcList Reference to list containing FtuFttValueSrc objects.

Returns: Reference to object itself.

  _setFileActionFromFtt 
_setFileActionFromFtt (
        self,
        action,
        keyCount,
        fttPafObj,
        )

Extract an Add or Change Translation Action from an FTT.

action: Action to extract: FtuFttAction.ftuACTION_ADD or FtuFttAction.ftuACTION_CHANGE.

keyCount: The present key count.

fttPafObj: Reference to the FTT Object.

Returns: Key counter in the FTT object.

  dump 
dump ( self )

Dump the contents of the object on stdout in PAF format.

Returns: Reference to object itself.

  dumpBuf 
dumpBuf ( self )

Dump the contents of the object into a string buffer in PAF format.

Returns: Reference to string buffer containing the generated File Action in PAF format.

  getPrefix 
getPrefix ( self )

Return prefix for File Action.

Returns: Prefix.

  isDefined 
isDefined ( self )

Indicates if it seems as though the object has been properly defined.

Returns: Returns 1 if object seems defined, otherwise 0.

  setPrefix 
setPrefix ( self,  prefix )

Set the prefix for the File Action (corresponds to FILE.PATH.BASE or FILE.RENAME.PREFIX).

prefix: String containing the prefix.

Returns: Reference to object itself.


Table of Contents

This document was automatically generated on Thu Feb 22 17:08:59 2001 by HappyDoc version r1_3