Table of Contents

Class: FtuFttDicRec FtuFttDicRec.py

Class to handle the information in connection with a DID Record.

Methods   
__init__
dump
dumpBuf
getComment
getFormat
getKey
getType
setComment
setFormat
setFromFttPaf
setKey
setType
  __init__ 
__init__ (
        self,
        key="",
        type="",
        format="",
        comment="",
        )

Constructor method initializing the object class variables.

key Name of keyword.

type Type of keyword (ftuTYPE_STRING, ftuTYPE_LOGICAL ftuTYPE_INTEGER, ftuTYPE_DOUBLE).

format Format of value (see DICB definition: http://www.eso.org/dicb).

comment Comment for keyword.

  dump 
dump ( self )

Dump contents of object on stdout in PAF format.

Returns: Reference to object itself.

  dumpBuf 
dumpBuf ( self )

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

Returns: Reference to string buffer containing the contents of for the DID Record.

  getComment 
getComment ( self )

Return comment for keyword.

Returns: Comment for keyword.

  getFormat 
getFormat ( self )

Return the value format for the keyword.

Returns: Value format.

  getKey 
getKey ( self )

Return name of keyword for object.

Returns: Name of key.

  getType 
getType ( self )

Return type of keyword.

Returns: Type.

  setComment 
setComment ( self,  comment )

Set the comment field for the keyword.

comment Comment field.

Returns: Reference to object itself.

  setFormat 
setFormat ( self,  format )

Set the format of the keyword value. Should be given in the C style.

format Format string, e.g. "%s", "%d", "%.5E".

Returns: Reference to object itself.

  setFromFttPaf 
setFromFttPaf (
        self,
        keyCount,
        fttPafObj,
        )

Extract the keywords for one FTT Dictionary Record from an FTT loaded into a PccPaf object, and return the new keyword counter (index) into the FTT PAF object keyword list.

keyCount Keyword index referring to a keyword number in the FTT PccPaf object.

fttPafObj Reference to the PccPaf object into which the FTT is loaded.

Returns: New keyword index.

  setKey 
setKey ( self,  key )

Set the name of the keyword.

key Name of the keyword.

Returns: Reference to the object itself.

  setType 
setType ( self,  type )

Set the type of the keyword. See constructor method.

type Type of keyword.

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